Class Session

An abstract class representing a session driver. Some implementation of this is injected into the request.

Hierarchy

Session
- MemorySession
- ORMSession

Index

Constructors

constructor

Properties

request

Methods

Constructors

constructor

new Session(): Session

Returns Session

Properties

Protected Readonly request

request: Request

Methods

Abstract forget

forget(key: string): void

- Defined in src/http/session/Session.ts:62
Remove a key from the session data.

Parameters
- key: string
Returns void

Abstract get

get(key: string, fallback?: unknown): any

- Defined in src/http/session/Session.ts:56
Get a value from the session by key.

Parameters
- key: string
- Optional fallback: unknown
Returns any

Abstract getData

getData(): SessionData

- Defined in src/http/session/Session.ts:50
Get the loaded session data as an object.

Returns SessionData

Abstract getKey

getKey(): string

- Defined in src/http/session/Session.ts:38
Get the unique key of this session.

Returns string

Abstract load

load(): void | Promise<void>

- Defined in src/http/session/Session.ts:44
Load the session data from the respective backend.

Returns void | Promise<void>

Abstract persist

persist(): void | Promise<void>

- Defined in src/http/session/Session.ts:47
Save the session data into the respective backend.

Returns void | Promise<void>

Abstract set

set(key: string, value: unknown): void

- Defined in src/http/session/Session.ts:59
Set a value in the session by key.

Parameters
- key: string
- value: unknown
Returns void

Abstract setData

setData(data: SessionData): void

- Defined in src/http/session/Session.ts:53
Bulk set an object as the session data.

Parameters
- data: SessionData
Returns void

Abstract setKey

setKey(key: string): void

- Defined in src/http/session/Session.ts:41
Set a unique key of this session.

Parameters
- key: string
Returns void

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.