Class CacheSession

A Session implementation that uses the configured Cache driver for persistence.

Hierarchy

Session
- CacheSession

Index

Constructors

Properties

cache config data? dirty key? request

Methods

forget formatKey get getData getExpiration getKey load persist safe set setData setKey

Constructors

constructor

new CacheSession(): CacheSession
Returns CacheSession

Inherited from Session.constructor

Properties

`Protected` `Readonly` cache

cache: Cache

`Protected` `Readonly` config

config: Config

`Protected` `Optional` data

data?: SessionData

`Protected` dirty

dirty: boolean = false

`Protected` `Optional` key

key?: string

`Protected` `Readonly` request

request: Request

Methods

forget

forget(key: string): void
Remove a key from the session data.
Parameters
- key: string
Returns void
Overrides Session.forget
- Defined in src/http/session/CacheSession.ts:23

`Private` formatKey

formatKey(): string
Returns string
- Defined in src/http/session/CacheSession.ts:90

get

get(key: string, fallback?: unknown): any
Get a value from the session by key.
Parameters
- key: string
- Optional fallback: unknown
Returns any
Overrides Session.get
- Defined in src/http/session/CacheSession.ts:32

getData

getData(): SessionData
Get the loaded session data as an object.

Returns SessionData
Overrides Session.getData
- Defined in src/http/session/CacheSession.ts:40

`Private` getExpiration

getExpiration(): Maybe<Date>
Returns Maybe<Date>
- Defined in src/http/session/CacheSession.ts:77

getKey

getKey(): string
Get the unique key of this session.

Returns string
Overrides Session.getKey
- Defined in src/http/session/CacheSession.ts:48

load

load(): Promise<void>
Load the session data from the respective backend.

Returns Promise<void>
Overrides Session.load
- Defined in src/http/session/CacheSession.ts:56

persist

persist(): Promise<void>
Save the session data into the respective backend.

Returns Promise<void>
Overrides Session.persist
- Defined in src/http/session/CacheSession.ts:67

safe

safe(key: string): Safe
Load a key from the session as a Safe value.
Parameters
- key: string
Returns Safe
Inherited from Session.safe
- Defined in src/http/session/Session.ts:65

set

set(key: string, value: unknown): void
Set a value in the session by key.
Parameters
- key: string
- value: unknown
Returns void
Overrides Session.set
- Defined in src/http/session/CacheSession.ts:102

setData

setData(data: SessionData): void
Bulk set an object as the session data.
Parameters
- data: SessionData
Returns void
Overrides Session.setData
- Defined in src/http/session/CacheSession.ts:111

setKey

setKey(key: string): void
Set a unique key of this session.
Parameters
- key: string
Returns void
Overrides Session.setKey
- Defined in src/http/session/CacheSession.ts:116