puppeteer/assets/js/facca145.0665c1ff.js

/*! For license information please see facca145.0665c1ff.js.LICENSE.txt */
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[22516],{79621:(e,i,r)=>{r.r(i),r.d(i,{assets:()=>o,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var n=r(85893),t=r(11151);const s={sidebar_label:"CookieParam"},d="CookieParam interface",c={id:"api/puppeteer.cookieparam",title:"CookieParam interface",description:"Cookie parameter object",source:"@site/../docs/api/puppeteer.cookieparam.md",sourceDirName:"api",slug:"/api/puppeteer.cookieparam",permalink:"/next/api/puppeteer.cookieparam",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{sidebar_label:"CookieParam"},sidebar:"api",previous:{title:"Cookie",permalink:"/next/api/puppeteer.cookie"},next:{title:"CookiePriority",permalink:"/next/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,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h1,{id:"cookieparam-interface",children:"CookieParam interface"}),"\n",(0,n.jsx)(i.p,{children:"Cookie parameter object"}),"\n",(0,n.jsx)(i.h4,{id:"signature",children:"Signature:"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-typescript",children:"export interface CookieParam\n"})}),"\n",(0,n.jsx)(i.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsxs)("table",{children:[(0,n.jsx)("thead",{children:(0,n.jsxs)("tr",{children:[(0,n.jsx)("th",{children:(0,n.jsx)(i.p,{children:"Property"})}),(0,n.jsx)("th",{children:(0,n.jsx)(i.p,{children:"Modifiers"})}),(0,n.jsx)("th",{children:(0,n.jsx)(i.p,{children:"Type"})}),(0,n.jsx)("th",{children:(0,n.jsx)(i.p,{children:"Description"})}),(0,n.jsx)("th",{children:(0,n.jsx)(i.p,{children:"Default"})})]})}),(0,n.jsxs)("tbody",{children:[(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"domain",children:"domain"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"string"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie domain."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"expires",children:"expires"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"number"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie expiration date, session cookie if not set"})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"httponly",children:"httpOnly"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"boolean"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"True if cookie is http-only."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"name",children:"name"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"string"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie name."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"partitionkey",children:"partitionKey"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"string"})}),(0,n.jsx)("td",{children:(0,n.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,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"path",children:"path"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"string"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie path."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"priority",children:"priority"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/next/api/puppeteer.cookiepriority",children:"CookiePriority"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie Priority. Supported only in Chrome."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"sameparty",children:"sameParty"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"boolean"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"True if cookie is SameParty. Supported only in Chrome."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"samesite",children:"sameSite"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/next/api/puppeteer.cookiesamesite",children:"CookieSameSite"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie SameSite type."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"secure",children:"secure"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"boolean"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"True if cookie is secure."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"sourcescheme",children:"sourceScheme"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"/next/api/puppeteer.cookiesourcescheme",children:"CookieSourceScheme"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie source scheme type. Supported only in Chrome."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"url",children:"url"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"optional"})})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"string"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"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."})}),(0,n.jsx)("td",{})]}),(0,n.jsxs)("tr",{children:[(0,n.jsx)("td",{children:(0,n.jsx)("span",{id:"value",children:"value"})}),(0,n.jsx)("td",{}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"string"})}),(0,n.jsx)("td",{children:(0,n.jsx)(i.p,{children:"Cookie value."})}),(0,n.jsx)("td",{})]})]})]})]})}function p(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},75251:(e,i,r)=>{var n=r(67294),t=Symbol.for("react.element"),s=Symbol.for("react.fragment"),d=Object.prototype.hasOwnProperty,c=n.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,o={key:!0,ref:!0,__self:!0,__source:!0};function l(e,i,r){var n,s={},l=null,h=null;for(n in void 0!==r&&(l=""+r),void 0!==i.key&&(l=""+i.key),void 0!==i.ref&&(h=i.ref),i)d.call(i,n)&&!o.hasOwnProperty(n)&&(s[n]=i[n]);if(e&&e.defaultProps)for(n in i=e.defaultProps)void 0===s[n]&&(s[n]=i[n]);return{$$typeof:t,type:e,key:l,ref:h,props:s,_owner:c.current}}i.Fragment=s,i.jsx=l,i.jsxs=l},85893:(e,i,r)=>{e.exports=r(75251)},11151:(e,i,r)=>{r.d(i,{Z:()=>c,a:()=>d});var n=r(67294);const t={},s=n.createContext(t);function d(e){const i=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function c(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),n.createElement(s.Provider,{value:i},e.children)}}}]);