docs/api/puppeteer.cookieparam.md
Cookie parameter object used to set cookies in the page-level cookies API.
export interface CookieParam
Property
</th><th>Modifiers
</th><th>Type
</th><th>Description
</th><th>Default
</th></tr></thead> <tbody><tr><td><span id="domain">domain</span>
</td><td>optional
string
</td><td>Cookie domain.
</td><td> </td></tr> <tr><td><span id="expires">expires</span>
</td><td>optional
number
</td><td>Cookie expiration date, session cookie if not set
</td><td> </td></tr> <tr><td><span id="httponly">httpOnly</span>
</td><td>optional
boolean
</td><td>True if cookie is http-only.
</td><td> </td></tr> <tr><td><span id="name">name</span>
</td><td> </td><td>string
</td><td>Cookie name.
</td><td> </td></tr> <tr><td><span id="partitionkey">partitionKey</span>
</td><td>optional
CookiePartitionKey | string
</td><td>Cookie partition key. In Chrome, it matches the top-level site the partitioned cookie is available in. In Firefox, it matches the source origin in the PartitionKey.
</td><td> </td></tr> <tr><td><span id="path">path</span>
</td><td>optional
string
</td><td>Cookie path.
</td><td> </td></tr> <tr><td><span id="priority">priority</span>
</td><td>optional
Cookie Priority. Supported only in Chrome.
</td><td> </td></tr> <tr><td><span id="sameparty">sameParty</span>
</td><td>optional, deprecated
boolean
</td><td>Deprecated:
Always ignored.
</td><td> </td></tr> <tr><td><span id="samesite">sameSite</span>
</td><td>optional
Cookie SameSite type.
</td><td> </td></tr> <tr><td><span id="secure">secure</span>
</td><td>optional
boolean
</td><td>True if cookie is secure.
</td><td> </td></tr> <tr><td><span id="sourcescheme">sourceScheme</span>
</td><td>optional
Cookie source scheme type. Supported only in Chrome.
</td><td> </td></tr> <tr><td><span id="url">url</span>
</td><td>optional
string
</td><td>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.
</td><td> </td></tr> <tr><td><span id="value">value</span>
</td><td> </td><td>string
</td><td>Cookie value.
</td><td> </td></tr> </tbody></table>