Class SessionStorage

Implements the Storage class for express-session using a Cache of @gibme/cache as the underlying storage provider

Hierarchy

Store
- SessionStorage

Index

Constructors

Methods

all clear destroy get length set touch

Constructors

constructor

new SessionStorage(options?): SessionStorage
Constructs a new instance of the class
Parameters
- options: Partial<{
      checkperiod: number;
      stdTTL: number;
      storage_provider: default;
  }> = {}
Returns SessionStorage
Overrides Store.constructor

Methods

all

all(callback): void
Returns all sessions from the store
Parameters
- callback: ((error, sessions) => void)
  - - (error, sessions): void
    - Parameters
      error: null | Error
      sessions: SessionData[]
      Returns void
Returns void
Overrides Store.all

clear

clear(callback): void
Delete all sessions from the store
Parameters
- callback: ((error) => void)
  - - (error): void
    - Parameters
      error: null | Error
      Returns void
Returns void
Overrides Store.clear

destroy

destroy(sid, callback): void
Destroys the session with the given session ID
Parameters
- sid: string
- callback: ((error) => void)
  - - (error): void
    - Parameters
      error: null | Error
      Returns void
Returns void
Overrides Store.destroy

get

get(sid, callback): void
Gets the session from the store given a session ID and passes it to callback.
Parameters
- sid: string
- callback: ((error, session?) => void)
  - - (error, session?): void
    - Parameters
      error: null | Error
      Optional session: null | SessionData
      Returns void
Returns void
Overrides Store.get

length

length(callback): void
Returns the amount of sessions in the store
Parameters
- callback: ((error, length) => void)
  - - (error, length): void
    - Parameters
      error: null | Error
      length: number
      Returns void
Returns void
Overrides Store.length

set

set(sid, session, callback): void
Upserts a session in the store given a session ID and SessionData
Parameters
- sid: string
- session: SessionData
- callback: ((error) => void)
  - - (error): void
    - Parameters
      error: null | Error
      Returns void
Returns void
Overrides Store.set

touch

touch(sid, _session, callback): void
"Touches" a given session, resetting the idle timer
Parameters
- sid: string
- _session: SessionData
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides Store.touch