puppeteer/website/versioned_docs/version-22.4.1/api/puppeteer.cookieparam.md
release-please[bot] e1a9b85bbe
chore: release main (#12056)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-03-08 13:12:17 +01:00

4.7 KiB

sidebar_label
CookieParam

CookieParam interface

Cookie parameter object

Signature:

export interface CookieParam

Properties

Property Modifiers Type Description Default
domain optional string Cookie domain.
expires optional number Cookie expiration date, session cookie if not set
httpOnly optional boolean True if cookie is http-only.
name string Cookie name.
partitionKey optional string Cookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. If not set, the cookie will be set as not partitioned.
path optional string Cookie path.
priority optional CookiePriority Cookie Priority. Supported only in Chrome.
sameParty optional boolean True if cookie is SameParty. Supported only in Chrome.
sameSite optional CookieSameSite Cookie SameSite type.
secure optional boolean True if cookie is secure.
sourceScheme optional CookieSourceScheme Cookie source scheme type. Supported only in Chrome.
url optional string The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, and source scheme values of the created cookie.
value string Cookie value.