Class DynamoSessionStore

Implements

SessionStore

Index

Constructors

Properties

client docClient lockVerificationProperty maxLockTime pollingFrequency pollingMaxAttempts tableName

Methods

close createDynamoDBTable destroy get getItem init lock pollUntilTableExists set unlock unset

Constructors

constructor

new DynamoSessionStore(options): DynamoSessionStore
Parameters
- options: SessionStoreOptions
Returns DynamoSessionStore
- Defined in DynamoSessionStore.ts:48

Properties

`Private` `Readonly` client

client: DynamoDBClient

`Private` `Readonly` docClient

docClient: DynamoDBDocumentClient

`Private` `Readonly` lockVerificationProperty

lockVerificationProperty: string

`Private` `Readonly` maxLockTime

maxLockTime: number

`Private` `Readonly` pollingFrequency

pollingFrequency: number

`Private` `Readonly` pollingMaxAttempts

pollingMaxAttempts: number

`Private` `Readonly` tableName

tableName: string

Methods

close

close(): Promise<void>
This is a noop function for dynamo

Returns Promise<void>
Implementation of SessionStore.close
- Defined in DynamoSessionStore.ts:271

createDynamoDBTable

createDynamoDBTable(): Promise<void>
Returns Promise<void>
- Defined in DynamoSessionStore.ts:273

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 DynamoSessionStore.ts:160

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 DynamoSessionStore.ts:74

`Private` getItem

getItem(id): Promise<undefined | SessionStoreData>
Parameters
- id: string
Returns Promise<undefined | SessionStoreData>
- Defined in DynamoSessionStore.ts:309

init

init(): Promise<void>
Create the session table if it doesn't already exist

Returns Promise<void>
Implementation of SessionStore.init
- Defined in DynamoSessionStore.ts:254

lock

lock(id, lockVerificationValue): Promise<boolean>
Attempt to lock the row
Parameters
- id: string
- lockVerificationValue: string
Returns Promise<boolean>
boolean - returns true if lock successful (unsuccessful lock throws LockError)

Throws
Error - a message declaring that the row is already locked, if that is the case
Implementation of SessionStore.lock
- Defined in DynamoSessionStore.ts:175

`Private` pollUntilTableExists

pollUntilTableExists(): Promise<void>
Polls DynamoDB until the table exists and its status is 'ACTIVE'.

Returns Promise<void>
Throws
Error - Will throw an error if the table doesn't become active within the max attempts.
- Defined in DynamoSessionStore.ts:324

set

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

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 DynamoSessionStore.ts:241

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 DynamoSessionStore.ts:130