Skip to main content
Version: 3.11

Cookie

Index

Properties

optionaldomain

domain?: string

Cookie domain.

optionalexpires

expires?: number

Cookie expiration date, session cookie if not set

optionalhttpOnly

httpOnly?: boolean

True if cookie is http-only.

name

name: string

Cookie name.

optionalpath

path?: string

Cookie path.

optionalpriority

priority?: Low | Medium | High

Cookie Priority.

optionalsameParty

sameParty?: boolean

True if cookie is SameParty.

optionalsameSite

sameSite?: Strict | Lax | None

Cookie SameSite type.

optionalsecure

secure?: boolean

True if cookie is secure.

optionalsourcePort

sourcePort?: number

Cookie source port. Valid values are -1 or 1-65535, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.

optionalsourceScheme

sourceScheme?: Unset | NonSecure | Secure

Cookie source scheme type.

optionalurl

url?: string

The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.

value

value: string

Cookie value.