CookieStore.getAll()

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

nameOptional

A USVString with the name of a cookie.

optionsOptional

An object containing:

name

A USVString with the name of a cookie.

url

A USVString with the url of a cookie.

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 or options 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

Browser compatibility