index overview

Added in v0.1.0

---

Table of contents

• constructors
  • endSession
  • getSession
  • storeSession
• model
  • SessionEnv (interface)

---

constructors

endSession

Returns a middleware that ends the current session.

Signature

export declare function endSession(): ReaderMiddleware<SessionEnv, HeadersOpen, HeadersOpen, Error, void>

Added in v0.1.2

getSession

Returns a middleware that returns the current session.

Signature

export declare function getSession<I = StatusOpen>(): ReaderMiddleware<
  SessionEnv,
  I,
  I,
  'no-session' | Error,
  JsonRecord
>

Added in v0.1.0

storeSession

Returns a middleware that stores a value in a session.

Signature

export declare function storeSession(
  session: JsonRecord
): ReaderMiddleware<SessionEnv, HeadersOpen, HeadersOpen, Error, void>

Added in v0.1.0

model

SessionEnv (interface)

Signature

export interface SessionEnv {
  secret: string
  sessionCookie: string
  sessionStore: Keyv
}

Added in v0.1.0