puppeteer/assets/js/fc0c5bc6.4409b3ac.js

/*! For license information please see fc0c5bc6.4409b3ac.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[74477],{83964:(e,i,r)=>{r.r(i),r.d(i,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var s=r(85893),n=r(11151);const t={sidebar_label:"CookieParam"},d="CookieParam interface",c={id:"api/puppeteer.cookieparam",title:"CookieParam interface",description:"Cookie parameter object",source:"@site/versioned_docs/version-22.6.4/api/puppeteer.cookieparam.md",sourceDirName:"api",slug:"/api/puppeteer.cookieparam",permalink:"/api/puppeteer.cookieparam",draft:!1,unlisted:!1,tags:[],version:"22.6.4",frontMatter:{sidebar_label:"CookieParam"},sidebar:"api",previous:{title:"Cookie",permalink:"/api/puppeteer.cookie"},next:{title:"CookiePriority",permalink:"/api/puppeteer.cookiepriority"}},o={},l=[{value:"Signature:",id:"signature",level:4},{value:"Properties",id:"properties",level:2}];function h(e){const i={a:"a",code:"code",h1:"h1",h2:"h2",h4:"h4",p:"p",pre:"pre",...(0,n.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"cookieparam-interface",children:"CookieParam interface"}),"\n",(0,s.jsx)(i.p,{children:"Cookie parameter object"}),"\n",(0,s.jsx)(i.h4,{id:"signature",children:"Signature:"}),"\n",(0,s.jsx)(i.pre,{children:(0,s.jsx)(i.code,{className:"language-typescript",children:"export interface CookieParam\n"})}),"\n",(0,s.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsxs)("table",{children:[(0,s.jsx)("thead",{children:(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(i.p,{children:"Property"})}),(0,s.jsx)("th",{children:(0,s.jsx)(i.p,{children:"Modifiers"})}),(0,s.jsx)("th",{children:(0,s.jsx)(i.p,{children:"Type"})}),(0,s.jsx)("th",{children:(0,s.jsx)(i.p,{children:"Description"})}),(0,s.jsx)("th",{children:(0,s.jsx)(i.p,{children:"Default"})})]})}),(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"domain",children:"domain"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"Cookie domain."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"expires",children:"expires"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"number"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"Cookie expiration date, session cookie if not set"})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"httponly",children:"httpOnly"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"boolean"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"True if cookie is http-only."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"name",children:"name"})}),(0,s.jsx)("td",{}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"Cookie name."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"partitionkey",children:"partitionKey"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{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. If not set, the cookie will be set as not partitioned."})}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:(0,s.jsx)("span",{id:"path",children:"path"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:(0,s.jsx)(i.code,{children:"optional"})})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{children:"string"})}),(0,s.jsx)("td",{children:(0,s.jsx)(i.p,{c