Session middleware
(require("Middleware_Session"))(options, app)
Initialize session middleware
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | Session options |
app |
Routable |
- Source:
- middlewares/session.js
Properties:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
options.key |
string |
<optional> |
'mowa:sid' | Cookie name defaulting to mowa.sid |
options.prefix |
string |
<optional> |
'mowa:sess:' | Session prefix for store, defaulting to mowa:sess: |
options.maxAge |
number |
<optional> |
SessionStore's expiration time (ms), defaulting to 86400000 (1 day) |
|
options.autoCommit |
bool |
<optional> |
true | Automatically commit headers (default true) |
options.overwrite |
bool |
<optional> |
true | Can overwrite or not (default true) |
options.httpOnly |
bool |
<optional> |
true | HttpOnly or not (default true) |
options.signed |
bool |
<optional> |
true | Signed or not |
options.rolling |
bool |
<optional> |
false | Force a session identifier cookie to be set on every response. The expiration is reset to the original maxAge, resetting the expiration countdown. (default is false) |
options.renew |
bool |
<optional> |
false | Renew session when session is nearly expired, so we can always keep user logged in. (default is false) |
options.genSid |
function |
<optional> |
The way of generating external session id is controlled by the options.genid, which defaults to Date.now() + '-' + uid.sync(24) |
|
options.valid |
function |
<optional> |
valid(ctx, session), valid session value before use it |
|
options.beforeSave |
function |
<optional> |
beforeSave(ctx, session), hook before save session |
|
options.store |
object |
<optional> |
Session store instance. It can be any Object that has the methods set, get, destroy like MemoryStore. |