Interface WebFlowCookie

Hierarchy

  • WebFlowCookie

Properties

name value domain? path? httpOnly? secure? sameSite?

Properties

name

name: string

The cookie name.

value

value: string

The cookie value.

Optional domain

domain?: string

The cookie domain. When omitted, defaults to the host of startUrl.

Optional path

path?: string

The cookie path. When omitted, defaults to "/".

Optional httpOnly

httpOnly?: boolean

Marks the cookie as HTTP-only, preventing access from JavaScript (document.cookie).

Default value: false

Optional secure

secure?: boolean

Marks the cookie as secure, so it is only sent over HTTPS connections.

Default value: false

Optional sameSite

sameSite?: "None" | "Lax" | "Strict"

Controls whether the cookie is sent with cross-site requests.

  • "None" — cookie is sent in all contexts (requires secure: true)
  • "Lax" — cookie is sent on top-level navigations and same-site requests
  • "Strict" — cookie is only sent in same-site requests

When omitted, the browser default applies (typically "Lax").

changelog

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc