CookieStore.getAll()
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getAll()
method of the CookieStore
interface returns a list of cookies that match the name or options passed to it. Passing no parameters will return all cookies for the current context.
Syntax
var list = cookieStore.getAll(name);
var list = cookieStore.getAll(options);
Parameters
name
Optional-
A
USVString
with the name of a cookie. options
Optional-
An object containing:
Note: The url
option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.
Return value
A Promise
that resolves with a list of cookies for the given name or options.
Exceptions
TypeError
-
Thrown if getting the cookie or cookies represented by the given
name
oroptions
fails.
Examples
In this example we use getAll()
with no parameters. This returns all of the cookies for this context as an array of objects.
let cookies = cookieStore.getAll();
if (cookies) {
console.log(cookies);
} else {
console.log('Cookie not found');
}
Specifications
Specification |
---|
Cookie Store API # dom-cookiestore-getall |
Browser compatibility
BCD tables only load in the browser