externalCookieData

A data structure describing a Cookie to be set, or one that's been read.

Learn more

• Cookie
• Page.cookie

Index

Properties

• name
• value
• domain
• path
• expiry
• httpOnly
• secure
• sameSite

Properties

externalname

name: string

The name of the cookie.

externalvalue

value: string

The value of the cookie.

externaloptionaldomain

domain?: string

The domain this cookie is visible to.

Defaults to the current browsing context's document's URL when setting a cookie.

externaloptionalpath

path?: string

The cookie path. Defaults to "/" when adding a cookie.

externaloptionalexpiry

expiry?: Timestamp

The timestamp describing the point in time when this cookie expires.

externaloptionalhttpOnly

httpOnly?: boolean

Whether the cookie is an HTTP-only cookie. Defaults to false when adding a new cookie.

externaloptionalsecure

secure?: boolean

Whether the cookie is a secure cookie. Defaults to false when adding a new cookie.

externaloptionalsameSite

sameSite?: Lax | Strict | None

Whether the cookie applies to a SameSite policy. Defaults to None if omitted when adding a cookie.