package
A Fastify plugin to maintain state on the server
npm install fastify-server-sessionGitHub-flavored package documentation.
Across all versions, last 30 days.
181 in 30 days
Runtime metadata.
Tagged topics.
This is a plugin for Fastify that facilitates keep state for clients between requests via server-side storage.
Requirements:
fastify.cache decorator.Installation:
npm install fastify-server-session fastify-cookie fastify-cachingUsing this implementation the sessions will be stored in memory on the Fastify instance making the server stateful. This is not recommended for production. It will not share state among multiple instances of the same application.
const fastify = require('fastify')()
fastify
.register(require('fastify-cookie'))
.register(require('fastify-caching'))
.register(require('fastify-server-session'), {
secretKey: 'some-secret-password-at-least-32-characters-long',
sessionMaxAge: 900000, // 15 minutes in milliseconds
cookie: {
domain: '.example.com',
path: '/'
}
})
fastify.get('/one', (req, reply) => {
req.session.foo = 'foo'
fastify-caching offers the connectivity to a remote store as shown below with ioredis and abstract-cache.
See fastify-caching documentation for other
storage capabilities.
// This example requires the following packages to be installed
// - ioredis
// - abstract-cache
const IORedis = require('ioredis')
const redis = new IORedis({host: '127.0.0.1'})
const abcache = require('abstract-cache')({
useAwait: true,
driver: {
name: 'abstract-cache-redis',
options: {client: redis}
}
})
const fastify = require('fastify')()
fastify
.register(require('fastify-cookie'))
.register
Note: In the previous example the sessionMaxAge value will set the Redis TTL of the session key.
The plugin accepts an options object with the following properties:
secretKey (Default: undefined): this is a required property that must
be a string with a minimum of 32 characters.sessionCookieName (Default: sessionid): a string to name the cookie sent
to the client to track the session.sessionMaxAge (Default: 1800000): a duration in milliseconds for which
the sessions will be valid.cookie: an options as described in the cookie module's documentation.
The default value is:
domain: undefinedexpires: same as sessionMaxAgehttpOnly: truepath: undefinedsameSite: trueTo use type checking on session object you can use the declaration:
declare module 'fastify' {
interface FastifyRequest {
session: {
foo: string;
bar: number;
};
}
}zekth
vince.legoff@gmail.com
Estimated unpacked size across 7 packages.
86.8 kB
Includes dependencies.
4 direct · 1 outdated
^2.1.5
2.1.5
^3.0.4
3.0.4
^3.0.0
6.0.1
^1.1.0
1.2.2