1.0.4 • Published 7 years ago

i-session-manager v1.0.4

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

i-session-manager

Session manager with Redis. Store and retrive data in JSON format.

Install

$ npm install --save i-session-manager

Configuration

locate the configuration file in node-modules/i-config and type the keys:

  • redis: Default { port:6379, host:'localhost',database:0}
  • sessionTimeout: Default 20 minutes.
  • userIdField: Default id. Specify the identity field in your record.
  • allowMultiSession: default true
    • true: User can have only one active session. If new login is performed the old session is discarded.
    • false: User can have more login simultaneously.

Usage

Create Session

  • @parameter
    • userData: JSON object
var s = require('i-session-manager')
var userData={
    "id": 3645,
    "username": "myusername",
    "type": 1,
    "name": "MyName",
    "surname": "MySurname",
    "grade": 1
    ... each other field you need to store in session
}
s.createSession(userData, function(err, token){/** **/});

Check Session

  • @parameter
    • token: string
  • @output

    • err: err or "session not valid"
    • userData: if err is null
var s = require('i-session-manager')
s.checkSession(token, function(err, userData){/** **/});

delete Session (logout)

  • @parameter

    • token: string
var s = require('i-session-manager')
s.deleteSession(token, function(err, userData){/** **/});

update Session

  • @parameter
    • token: string use this function to refresh the timeout
var s = require('i-session-manager')
s.updateSession(token, function(err, userData){/** **/});
1.0.4

7 years ago

1.0.3

8 years ago

1.0.2

8 years ago

1.0.1

8 years ago

1.0.0

8 years ago