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):

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).

firstPartyDomainOptional

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. You can however pass null in this situation. If you do this, then cookies with any value for firstPartyDomain, as well as cookies which do not have firstPartyDomain set at all, will be included in the results. See First-party isolation.

nameOptional

A string representing a name that the cookies should have.

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 vs. non-secure cookies..

sessionOptional

A boolean— filters the cookies by their session property, allowing you to filter session cookies vs. 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.

urlOptional

A string representing a URL that the retrieved cookies must be associated with.

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

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 "favorite-color". When the result is returned, we are printing the value of each result to the console.

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

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

Example extensions

• list-cookies