Class MemorySessionStore

Implements

SessionStore

Index

Constructors

Properties

cache maxLockTime stdTTL

Methods

close convertUnixTTlToSeconds destroy get init lock set unlock unset

Constructors

constructor

new MemorySessionStore(options?): MemorySessionStore
Parameters
- Optional options: SessionStoreOptions
Returns MemorySessionStore
- Defined in packages/session/src/MemorySessionStore.ts:16

Properties

`Private` `Readonly` cache

cache: NodeCache

`Private` `Readonly` maxLockTime

maxLockTime: number

The number of seconds that a session is allowed to be locked before it can be forcibly unlocked.

`Private` `Readonly` stdTTL

stdTTL: number

Methods

close

close(): Promise<void>
Close the session store

Returns Promise<void>
Implementation of SessionStore.close
- Defined in packages/session/src/MemorySessionStore.ts:87

`Private` convertUnixTTlToSeconds

convertUnixTTlToSeconds(unixTTL): number
Parameters
- unixTTL: number
Returns number
- Defined in packages/session/src/MemorySessionStore.ts:91

destroy

destroy(id): Promise<boolean>
Destroy the session data
Parameters
- id: string
  the id of the session to delete
Returns Promise<boolean>
Implementation of SessionStore.destroy
- Defined in packages/session/src/MemorySessionStore.ts:52

get

get(id): Promise<undefined | SessionData>
Get the contents of the session
Parameters
- id: string
  the session id
Returns Promise<undefined | SessionData>
Implementation of SessionStore.get
- Defined in packages/session/src/MemorySessionStore.ts:25

init

init(): Promise<void>
Initialize the session store

Returns Promise<void>
Implementation of SessionStore.init
- Defined in packages/session/src/MemorySessionStore.ts:83

lock

lock(id, _lockVerificationValue): Promise<boolean>
lock a session row so that other clients cannot modify its data
Parameters
- id: string
  the id of the session to lock
- _lockVerificationValue: string
  the property key to use for safety checking against the stored session
Returns Promise<boolean>
boolean - true if lock was successful (unsuccessful lock throws LockError)

Throws
LockError - a message declaring that the row is already locked, if that is the case
Implementation of SessionStore.lock
- Defined in packages/session/src/MemorySessionStore.ts:57

set

set(id, data): Promise<boolean>
Adds or updates (if the fields already exist) data in the session
Parameters
- id: string
  the session id
- data: SessionStoreData
  the data to add or update
Returns Promise<boolean>
Implementation of SessionStore.set
- Defined in packages/session/src/MemorySessionStore.ts:32

unlock

unlock(id): Promise<boolean>
unlock a session row so that other clients can modify its data
Parameters
- id: string
  the id of the session to unlock
Returns Promise<boolean>
Implementation of SessionStore.unlock
- Defined in packages/session/src/MemorySessionStore.ts:73

unset

unset(id, properties): Promise<boolean>
Removes the given properties from the session object No error will be thrown if any of the provided fields don't exist.

Returns false if the id wasn't found. Otherwise, returns true.
Parameters
- id: string
  the session id
- properties: string[]
  the names of the properties or indexes to remove
Returns Promise<boolean>
Implementation of SessionStore.unset
- Defined in packages/session/src/MemorySessionStore.ts:43