cookies.getAll()

The getAll() method of the cookies API retrieves all cookies from a single cookie store that match the given information.

This is an asynchronous function that returns a Promise.

Syntax

var getting = browser.cookies.getAll(
  details                // object
)

Parameters

details
An object containing details that can be used to match cookies to be retrieved. Included properties are as follows (see Cookie type for more information on these):
urlOptional
A string representing a URL that the retrieved cookies must be associated with.
nameOptional
A string representing a name that the cookies should have.
domainOptional
A string representing a domain that cookies must be associated with (they can be associated either with this exact domain or one of its subdomains).
pathOptional
A string representing a path — the cookies' path must be identical to this one.
secureOptional
A boolean — filters cookies by their secure property, allowing you to filter secure cookies versus non-secure cookies..
sessionOptional
A boolean— filters the cookies by their session property, allowing you to filter session cookies versus persistent cookies.
storeIdOptional
A string representing the cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used.

Return value

A Promise that will be fulfilled with an array of  cookies.Cookie objects that match the properties given in the details parameter. Only unexpired cookies are returned. The cookies returned will be sorted by path length, longest to shortest. If multiple cookies have the same path length, those with the earliest creation time will be first.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Compatibility notes

Edge

  • If no URL is provided, cookies are retrieved only for URLs in currently opened tabs. In Chrome, this gets all cookies on a user’s machine.

Examples

In the following snippet, we are making a call to get all of the cookies the browser currently has stored that have a name of "favourite-colour". When the result is returned, we are printing the value of each result to the console.

function logCookies(cookies) {
  for (cookie of cookies) {
    console.log(cookie.value);
  }
}

var gettingAll = browser.cookies.getAll({
  name: "favourite-colour"
});
gettingAll.then(logCookies);

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, maravillosa, Makyen, chrisdavidmills
 Last updated by: wbamberg,