CookieParam interface
Cookie parameter object used to set cookies in the page-level cookies API.
Signature
export interface CookieParam
Properties
Property | Modifiers | Type | Description | Default |
|---|---|---|---|---|
| domain |
| string | Cookie domain. | |
| expires |
| number | Cookie expiration date, session cookie if not set | |
| httpOnly |
| boolean | True if cookie is http-only. | |
| name | string | Cookie name. | ||
| partitionKey |
| CookiePartitionKey | string | 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. | |
| path |
| string | Cookie path. | |
| priority |
| Cookie Priority. Supported only in Chrome. | ||
| sameParty |
| boolean | True if cookie is SameParty. Supported only in Chrome. | |
| sameSite |
| Cookie SameSite type. | ||
| secure |
| boolean | True if cookie is secure. | |
| sourceScheme |
| Cookie source scheme type. Supported only in Chrome. | ||
| url |
| 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. |