cookies.set()

Sets a cookie. This method is equivalent to issuing an HTTPSet-Cookie header during a request to a URL.

To use this method, an extension must have the"cookies" permission and relevant host permissions. Seecookie permissions for more details.

Syntax

let setting = browser.cookies.set(  details               // object)

Parameters

details

Anobject containing the details of the cookie you wish to set. It can have these properties:

domainOptional

Astring representing the domain of the cookie. If omitted, the cookie becomes a host-only cookie.

expirationDateOptional

Anumber that represents the expiration date of the cookie as the seconds after the UNIX epoch. Can include milliseconds in the fractional part. If omitted, the cookie becomes a session cookie.

firstPartyDomainOptional

Astring representing the first-party domain with which the cookie is associated. This property must be supplied if the browser has first-party isolation enabled. SeeFirst-party isolation.

httpOnlyOptional

Aboolean that specifies whether the cookie is marked as HttpOnly (true), or not (false). If omitted, it defaults to false.

nameOptional

Astring representing the name of the cookie. If omitted, this is empty by default.

partitionKeyOptional

Anobject representing thestorage partition to set the cookie in. Include this object to set a cookie in partitioned storage. This object contains:

topLevelSiteOptional: Astring representing the first-party URL of the top-level site storage partition containing the cookie.

pathOptional

Astring representing the path of the cookie. If omitted, this defaults to the path portion of the URL parameter.

sameSiteOptional

Acookies.SameSiteStatus value that indicates the SameSite state of the cookie. If omitted, defaults tounspecified.

secureOptional

Aboolean that specifies whether the cookie is marked as secure (true), or not (false). If omitted, it defaults to false.

storeIdOptional

Astring representing the ID of the cookie store in which to set the cookie. If omitted, the cookie is set in the current execution context's cookie store.

url

Astring representing the request-URI to associate with the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the method call fails.

valueOptional

Astring representing the value of the cookie. If omitted, this is empty by default.

Return value

APromise fulfilled with acookies.Cookie object containing details about the set cookie.

If there is more than one cookie with the same name for a URL, the cookie with the longest path is returned. For cookies with the same path length, the cookie with the earliest creation time is returned.

Note:Before Firefox 133, when there was more than one cookie with the same name, Firefox returned the cookie with the earliest creation time.

If the requested cookie is invalid or the call otherwise fails, the promise is rejected with an error message.

Note:Before Firefox 145, invalid cookies were created.

Examples

This example sets a cookie for the document hosted by the active tab:

let getActive = browser.tabs.query({ active: true, currentWindow: true });getActive.then(setCookie);function setCookie(tabs) {  browser.cookies.set({    url: tabs[0].url,    name: "favorite-color",    value: "red",  });}