cookies.get()

Syntax

let getting = browser.cookies.get(
  details                // object
)

Parameters

details

An object containing details that are used to match a cookie to be retrieved. It can include these properties:

firstPartyDomain Optional

A string representing the first-party domain with which the cookie to retrieve is associated. This property must be supplied if the browser has first-party isolation enabled. See First-party isolation.

name

A string representing the name of the cookie to retrieve.

partitionKey Optional

An object representing the storage partition containing the cookie. Include this object with topLevelSite to obtain a cookie from partitioned storage. Otherwise, returns the cookie from unpartitioned storage. This object contains:

topLevelSite Optional

A string representing the first-party URL of the top-level site storage partition containing the cookie.

storeId Optional

A string representing the ID of the cookie store in which to look for the cookie (as returned by cookies.getAllCookieStores()). By default, the current execution context's cookie store is used.

url

A string representing the URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g., the query string) is ignored. If host permissions for this URL are not specified in the extension's manifest file, the API call fails.

Return value

A Promise that is fulfilled with a Cookie object containing details about the cookie, or null if the cookie is not found.

Examples

This example tries to get the cookie named "favorite-color" associated with the URL for the active tab:

function logCookie(cookie) {
  if (cookie) {
    console.log(cookie.value);
  }
}

function getCookie(tabs) {
  let getting = browser.cookies.get({
    url: tabs[0].url,
    name: "favorite-color",
  });
  getting.then(logCookie);
}

let getActive = browser.tabs.query({
  active: true,
  currentWindow: true,
});
getActive.then(getCookie);

Example extensions

• cookie-bg-picker

Browser compatibility