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
let 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):domain
Optional-
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). 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. You can however pass
null
in this situation. If you do this, then cookies with any value forfirstPartyDomain
, as well as cookies which do not havefirstPartyDomain
set at all, will be included in the results. See First-party isolation. name
Optional-
A
string
representing a name that the cookies should have. partitionKey
Optional-
An
object
defining which storage partitions to return cookies from:- if omitted, returns only cookies from unpartitioned storage.
- if included without
topLevelSite
, returns all cookies from partitioned and unpartitioned storage. - if included with
topLevelSite
specified, returns cookies from the specified partition storage.
This object contains:
topLevelSite
Optional-
A
string
representing the first-party URL of the top-level site storage partition containing the cookies.
path
Optional-
A
string
representing a path — the cookies' path must be identical to this one. secure
Optional-
A
boolean
— filters cookies by theirsecure
property, allowing you to filter secure cookies vs. non-secure cookies. session
Optional-
A
boolean
— filters the cookies by theirsession
property, allowing you to filter session cookies vs. persistent cookies. storeId
Optional-
A
string
representing the cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used. url
Optional-
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
objects that match the properties given in the cookies.Cookie
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
BCD tables only load in the browser
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 (const cookie of cookies) {
console.log(cookie.value);
}
}
browser.cookies
.getAll({
name: "favorite-color",
})
.then(logCookies);
Example extensions
Note: This API is based on Chromium's chrome.cookies
API. This documentation is derived from cookies.json
in the Chromium code.