Class: FastifyHttpSession<T>
Represents an HTTP session, providing methods to manage session data, including getting, setting, checking, deleting, and clearing session values. Also includes methods to save, reload, regenerate, destroy, and touch the session.
Type Parameters
T
T extends object = Record<string, unknown>
Implements
HttpSession<T>
Constructors
Constructor
new FastifyHttpSession<
T>(session):FastifyHttpSession<T>
Parameters
session
FastifySessionObject
Returns
FastifyHttpSession<T>
Accessors
data
Get Signature
get data():
Readonly<T>
Returns
Readonly<T>
Implementation of
id
Get Signature
get id():
string
Returns
string
Implementation of
Methods
clear()
clear():
void
Returns
void
Implementation of
delete()
delete<
K>(key):boolean
Type Parameters
K
K extends string | number | symbol
Parameters
key
K
Returns
boolean
Implementation of
destroy()
destroy():
Promise<void>
Returns
Promise<void>
Implementation of
get()
get<
K>(key):T[K] |undefined
Type Parameters
K
K extends string | number | symbol
Parameters
key
K
Returns
T[K] | undefined
Implementation of
has()
has<
K>(key):boolean
Type Parameters
K
K extends string | number | symbol
Parameters
key
K
Returns
boolean
Implementation of
regenerate()
regenerate():
Promise<void>
Returns
Promise<void>
Implementation of
reload()
reload():
Promise<void>
Returns
Promise<void>
Implementation of
save()
save():
Promise<void>
Returns
Promise<void>
Implementation of
set()
set<
K>(key,value):void
Type Parameters
K
K extends string | number | symbol
Parameters
key
K
value
T[K]
Returns
void
Implementation of
touch()
touch():
Promise<void>
Returns
Promise<void>