Class RedisSessionStore<TPayload>

Redis-backed implementation of SessionKit SessionStore.

Type Parameters

TPayload

Implements

SessionStore<TPayload>

Index

Constructors

Methods

get set del touch close getClientManager makeKey

Properties

keyPrefix codec clientManager

Constructors

constructor

new RedisSessionStore<TPayload>(
connection: RedisConnectionInput,
options?: RedisSessionStoreOptions<TPayload>,
): RedisSessionStore<TPayload>
Type Parameters
- TPayload
Parameters
- connection: RedisConnectionInput
- Optionaloptions: RedisSessionStoreOptions<TPayload>
Returns RedisSessionStore<TPayload>
- Defined in packages/redis/src/RedisSessionStore.ts:37

Methods

get

get(sessionId: string): Promise<null | StoredSession<TPayload>>
Parameters
- sessionId: string
Returns Promise<null | StoredSession<TPayload>>
Implementation of SessionStore.get
- Defined in packages/redis/src/RedisSessionStore.ts:43

set

set(
    sessionId: string,
    value: StoredSession<TPayload>,
    ttlSeconds: number,
): Promise<void>
Parameters
- sessionId: string
- value: StoredSession<TPayload>
- ttlSeconds: number
Returns Promise<void>
Implementation of SessionStore.set
- Defined in packages/redis/src/RedisSessionStore.ts:57

del

del(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
Implementation of SessionStore.del
- Defined in packages/redis/src/RedisSessionStore.ts:66

touch

touch(sessionId: string, ttlSeconds: number): Promise<void>
Parameters
- sessionId: string
- ttlSeconds: number
Returns Promise<void>
Implementation of SessionStore.touch
- Defined in packages/redis/src/RedisSessionStore.ts:71

close

close(): Promise<void>
Returns Promise<void>
Implementation of SessionStore.close
- Defined in packages/redis/src/RedisSessionStore.ts:89

getClientManager

getClientManager(): RedisClientManager
Exposes internal client manager so lock provider can reuse connections.

Returns RedisClientManager
- Defined in packages/redis/src/RedisSessionStore.ts:96

`Private`makeKey

makeKey(sessionId: string): string
Parameters
- sessionId: string
Returns string
- Defined in packages/redis/src/RedisSessionStore.ts:100

Properties

`Private` `Readonly`keyPrefix

keyPrefix: string

`Private` `Readonly`codec

codec: SessionCodec<TPayload>

`Private` `Readonly`clientManager

clientManager: RedisClientManager