Class SessionStore`Abstract`

Implemented by

MemorySessionStore

Index

Constructors

Methods

close destroy get init lock set unlock unset

Constructors

constructor

new SessionStore(): SessionStore
Returns SessionStore

Methods

`Abstract` close

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

Returns Promise<void>
- Defined in packages/session/src/SessionStore.ts:60

`Abstract` destroy

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

`Abstract` get

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

`Abstract` init

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

Returns Promise<void>
- Defined in packages/session/src/SessionStore.ts:55

`Abstract` 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
- Defined in packages/session/src/SessionStore.ts:69

`Abstract` 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>
- Defined in packages/session/src/SessionStore.ts:34

`Abstract` 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>
- Defined in packages/session/src/SessionStore.ts:75

`Abstract` 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>
- Defined in packages/session/src/SessionStore.ts:44