Skip to main content

CookieOptions

@webda/core • Readme | API

Class: CookieOptions

Cookie Options

Implements​

  • Omit<SerializeOptions, "domain">

Constructors​

new CookieOptions(options, httpContext)​

new CookieOptions(options, httpContext?): CookieOptions

Load with default value

Parameters​

• options: Partial<CookieOptions>

• httpContext?: HttpContext

Returns​

CookieOptions

Source​

packages/core/src/utils/cookie.ts:56

Properties​

domain?​

domain?: string | true

if true domain will be set to the request hostname if undefined no domain will be output (browser will use the current domain and only this one) if a string is provided it will be used as the domain

When provided a domain is setting the cookie to be available to all subdomains

Source​

packages/core/src/utils/cookie.ts:27

httpOnly?​

httpOnly?: boolean

Default​

true

Implementation of​

Omit.httpOnly

Source​

packages/core/src/utils/cookie.ts:40

maxAge?​

maxAge?: number

Minimum​

1

Default​

86400 * 7

Implementation of​

Omit.maxAge

Source​

packages/core/src/utils/cookie.ts:32

name?​

name?: string

Name of the cookie

Source​

packages/core/src/utils/cookie.ts:49

path?​

path?: string

Default​

/

Implementation of​

Omit.path

Source​

packages/core/src/utils/cookie.ts:36

sameSite?​

sameSite?: "strict" | "lax" | "none"

Default​

lax

Implementation of​

Omit.sameSite

Source​

packages/core/src/utils/cookie.ts:19

secure?​

secure?: boolean

If not set will be true if https request and false otherwise If defined it will be set to the value

Implementation of​

Omit.secure

Source​

packages/core/src/utils/cookie.ts:45