cookies.getAllCookieStores()

The getAllCookieStores() method of the cookies API returns a list of all cookie stores.

To use this method, an extension must have the "cookies" permission. See cookie permissions for more details.

This is an asynchronous function that returns a Promise.

Syntax

js
let gettingStores = browser.cookies.getAllCookieStores()

Parameters

None.

Return value

A Promise that is fulfilled with an array of cookies.CookieStore objects representing all the cookie stores.

Examples

In this snippet, the getAllCookieStores() method is used to retrieve all the cookie stores available in the browser, and print out each cookie store ID, and the tabs that share each cookie store.

js
function logStores(cookieStores) {
  for (const store of cookieStores) {
    console.log(`Cookie store: ${store.id}\n Tab IDs: ${store.tabIds}`);
  }
}

browser.cookies.getAllCookieStores().then(logStores);

Each member of the cookieStores array is a cookies.CookieStore object.

Browser compatibility

BCD tables only load in the browser

Note: This API is based on Chromium's chrome.cookies API. This documentation is derived from cookies.json in the Chromium code.