puppeteer/assets/js/a7a42000.363c6e29.js

/*! For license information please see a7a42000.363c6e29.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[45913],{4658:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>a,frontMatter:()=>n,metadata:()=>d,toc:()=>l});var i=r(85893),s=r(11151);const n={sidebar_label:"Cookie"},o="Cookie interface",d={id:"api/puppeteer.cookie",title:"Cookie interface",description:"Represents a cookie object.",source:"@site/versioned_docs/version-22.0.0/api/puppeteer.cookie.md",sourceDirName:"api",slug:"/api/puppeteer.cookie",permalink:"/api/puppeteer.cookie",draft:!1,unlisted:!1,tags:[],version:"22.0.0",frontMatter:{sidebar_label:"Cookie"},sidebar:"api",previous:{title:"ContinueRequestOverrides",permalink:"/api/puppeteer.continuerequestoverrides"},next:{title:"CookieParam",permalink:"/api/puppeteer.cookieparam"}},c={},l=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function h(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"cookie-interface",children:"Cookie interface"}),"\n",(0,i.jsx)(t.p,{children:"Represents a cookie object."}),"\n",(0,i.jsx)(t.h4,{id:"signature",children:"Signature:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"export interface Cookie\n"})}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Property"}),(0,i.jsx)(t.th,{children:"Modifiers"}),(0,i.jsx)(t.th,{children:"Type"}),(0,i.jsx)(t.th,{children:"Description"}),(0,i.jsx)(t.th,{children:"Default"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"domain"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"string"}),(0,i.jsx)(t.td,{children:"Cookie domain."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"expires"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"number"}),(0,i.jsxs)(t.td,{children:["Cookie expiration date as the number of seconds since the UNIX epoch. Set to ",(0,i.jsx)("code",{children:"-1"})," for session cookies"]}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"httpOnly"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"boolean"}),(0,i.jsx)(t.td,{children:"True if cookie is http-only."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"name"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"string"}),(0,i.jsx)(t.td,{children:"Cookie name."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"partitionKey"}),(0,i.jsx)(t.td,{children:(0,i.jsx)("code",{children:"optional"})}),(0,i.jsx)(t.td,{children:"string"}),(0,i.jsx)(t.td,{children:"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. Supported only in Chrome."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"partitionKeyOpaque"}),(0,i.jsx)(t.td,{children:(0,i.jsx)("code",{children:"optional"})}),(0,i.jsx)(t.td,{children:"boolean"}),(0,i.jsx)(t.td,{children:"True if cookie partition key is opaque. Supported only in Chrome."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"path"}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:"string"}),(0,i.jsx)(t.td,{children:"Cookie path."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"priority"}),(0,i.jsx)(t.td,{children:(0,i.jsx)("code",{children:"optional"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/api/puppeteer.cookiepriority",children:"CookiePriority"})}),(0,i.jsx)(t.td,{children:"Cookie Priority. Supported only in Chrome."}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"sameParty"}),(0,i.jsx)(t.td,{children:(0,i.jsx)("code",{children:"optional"})}),(0,i.jsx)(t.td,{children:"boolean"}),(0,i.jsx)(t.td,{children:"True if cookie is SameParty. Suppo