Interface SessionOptions<S>

Options for configuring session middleware.

interface SessionOptions<S> {
    getSessionKey?: (context: CallbackContext) => string | undefined;
    initial?: () => S;
    prefix?: string;
    storage?: SessionStorage<S>;
}

Type Parameters

S
Shape of the session data.

Index

Properties

getSessionKey? initial? prefix? storage?

Properties

`Optional`getSessionKey

getSessionKey?: (context: CallbackContext) => string | undefined

Custom session key generator function. Default: extracts user ID or chat ID.

`Optional`initial

initial?: () => S

Factory function returning initial state for new sessions.

`Optional`prefix

prefix?: string

Key prefix for namespacing session records. Default: "session:".

`Optional`storage

storage?: SessionStorage<S>

Storage backend instance. Default: MemorySessionStorage.