Class Session

Session manager class.

Hierarchy

  • Session

Constructors

constructor

Properties

_app cookieName cookiePath expiration httpOnly sameSite secure

Methods

load store decrypt encrypt

Constructors

constructor

  • Parameters

    Returns Session

Properties

_app

_app: WeakRef<App>

cookieName

cookieName: string = 'mojo'

Name for session cookies, defaults to mojo.

cookiePath

cookiePath: string = '/'

Path for session cookies, defaults to /.

expiration

expiration: number = 3600

Default time for sessions to expire in seconds from now, defaults to 3600. The expiration timeout gets refreshed for every request. Setting the value to 0 will allow sessions to persist until the browser window is closed, this can have security implications though.

httpOnly

httpOnly: boolean = true

Set the HttpOnly value on all session cookies.

sameSite

sameSite: "none" | "strict" | "lax" = 'lax'

Set the SameSite value on all session cookies, defaults to lax.

secure

secure: boolean = false

Set the secure flag on all session cookies, so that browsers send them only over HTTPS connections.

Methods

load

  • Load session data from encrypted cookie.

    Parameters

    Returns Promise<null | SessionData>

store

  • Store session data in encrypted cookie.

    Parameters

    Returns Promise<void>

Static decrypt

  • Decrypt cookie.

    Parameters

    • secrets: string[]
    • encrypted: string

    Returns Promise<null | string>

Static encrypt

  • Encrypt cookie.

    Parameters

    • secret: string
    • value: string

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc