Skip to content
Shokupan

SessionOptions

Defined in: src/plugins/middleware/session.ts:52

Properties

Section titled “Properties”
Section titled “cookie?”

optional cookie: SessionCookieOptions

Defined in: src/plugins/middleware/session.ts:68

Options for the session cookie.

genid()?

Section titled “genid()?”

optional genid: (ctx) => string

Defined in: src/plugins/middleware/session.ts:72

Function to generate a session ID.

Parameters

Section titled “Parameters”
ctx
Section titled “ctx”

ShokupanContext

Returns

Section titled “Returns”

string

name?

Section titled “name?”

optional name: string

Defined in: src/plugins/middleware/session.ts:60

Name of the session cookie.

resave?

Section titled “resave?”

optional resave: boolean

Defined in: src/plugins/middleware/session.ts:76

Whether to force a session identifier cookie to be set on every response.

rolling?

Section titled “rolling?”

optional rolling: boolean

Defined in: src/plugins/middleware/session.ts:84

Whether to update the session cookie on every request.

saveUninitialized?

Section titled “saveUninitialized?”

optional saveUninitialized: boolean

Defined in: src/plugins/middleware/session.ts:80

Whether to save the session on every request.

secret

Section titled “secret”

secret: string | string[]

Defined in: src/plugins/middleware/session.ts:56

Secret used to sign the session cookie.

store?

Section titled “store?”

optional store: Store

Defined in: src/plugins/middleware/session.ts:64

Store to use for session data.

unset?

Section titled “unset?”

optional unset: "destroy" | "keep"

Defined in: src/plugins/middleware/session.ts:88

Whether to destroy or keep the session on logout.