Simple cookie-based session middleware.
A user session can be stored in two main ways with cookies: on the server or on the client. This module stores the session data on the client within a cookie, while a module like express-session stores only a session identifier on the client within a cookie and stores the session data on the server, typically in a database.
The following points can help you choose which to use:
cookie-sessiondoes not require any database / resources on the server side, though the total session data cannot exceed the browser's max cookie size.
cookie-sessioncan simplify certain load-balanced scenarios.
cookie-sessioncan be used to store a "light" session and include an identifier to look up a database-backed secondary store to reduce database lookups.
This module provides "guest" sessions, meaning any visitor will have a session,
authenticated or not. If a session is new a
Set-Cookie will be produced regardless
of populating the session.
$ npm install cookie-session
var cookieSession =
Create a new cookie session middleware with the provided options.
Cookie session accepts these properties in the options object.
The name of the cookie to set, defaults to
The list of keys to use to sign & verify cookie values. Set cookies are always
keys, while the other keys are valid for verification, allowing
for key rotation.
A string which will be used as single key if
keys is not provided.
Other options are passed to
cookies.set() allowing you
to control security, domain, path, and signing among other settings.
The options can also contain any of the following (for the full list, see cookies module documentation:
maxAge: a number representing the milliseconds from
Dateobject indicating the cookie's expiration date (expires at the end of session by default).
path: a string indicating the path of the cookie (
domain: a string indicating the domain of the cookie (no default).
secure: a boolean indicating whether the cookie is only to be sent over HTTPS (
falseby default for HTTP,
trueby default for HTTPS).
secureProxy: a boolean indicating whether the cookie is only to be sent over HTTPS (use this if you handle SSL not in your node process).
signed: a boolean indicating whether the cookie is to be signed (
overwrite: a boolean indicating whether to overwrite previously set cookies of the same name (
Represents the session for the given request.
true if the session is new.
Determine if the session has been populated with data or is empty.
Represents the session options for the current request. These options are a shallow clone of what was provided at middleware construction and can be altered to change cookie setting behavior on a per-request basis.
Destroying a session
To destroy a session simply set it to
reqsession = null
Simple view counter example
var cookieSession =var express =var app =app // trust first proxyappappapp
Per-user sticky max age
var cookieSession =var express =var app =app // trust first proxyapp// This allows you to set req.session.maxAge to let certain sessions// have a different value than the default.app// ... your logic here ...