Class Session

constructor

• new Session(
      sessionId: string,
      sessionStore: SessionStore,
      options?: SessionOptions,
  ): Session

  Parameters

  • sessionId: string
  • sessionStore: SessionStore
  • Optionaloptions: SessionOptions

  Returns Session

Readonlyid

Readonlystore

data

• get data(): Readonly<SessionData>

  Do not allow external direct manipulation of SessionData; must use set function so we can track changed values for saving

  Returns Readonly<SessionData>

isExpired

• get isExpired(): boolean

  Returns boolean

delete

• delete(key: string | number): this

  Parameters

  • key: string | number

  Returns this

destroy

• destroy(): Promise<void>

  Returns Promise<void>

get

• get<K extends string | number>(key: K): SessionData[K]

  Get a single value from the session data in memory.

  Type Parameters

  • K extends string | number

  Parameters

  • key: K

    The property to retrieve from the session data.

  Returns SessionData[K]

  The value corresponding to the given key.

load

• load(): Promise<void>

  Returns Promise<void>

lock

• lock(lockVerificationValue: string): Promise<boolean>

  Attempts to lock the session row. Also updates the data with the current data from the database. If it was not successful, then the rows must already be locked. If the function fails for some other reason, an exception will be thrown.

  Parameters

  • lockVerificationValue: string

  Returns Promise<boolean>

  whether the attempt to lock the session row was successful

pop

• pop<Key extends string | number>(key: Key): SessionData[Key] | undefined

  Type Parameters

  • Key extends string | number

  Parameters

  • key: Key

  Returns SessionData[Key] | undefined

save

• save(force?: boolean): Promise<void>

  Saves the state to the session store, if there are changes

  Parameters

  • force: boolean = false

    Skips the check for changes to the state

  Returns Promise<void>

set

• set(items: Partial<SessionData>): this

  Set or update one or more values in memory only. If you need to persist changes immediately, call the save function.

  Parameters

  • items: Partial<SessionData>

    an object of items to add or update

  Returns this

  Example

  `await this.set(key, prop).save()`
  Copy

• set<K extends string>(key: K, value: unknown): this

  Set or update one or more values in memory only. If you need to persist changes immediately, call the save function.

  Type Parameters

  • K extends string

  Parameters

  • key: K
  • value: unknown

  Returns this

  Example

  `await this.set(key, prop).save()`
  Copy

touch

• touch(): void

  Returns void

unlock

• unlock(): Promise<boolean>

  Returns Promise<boolean>