CookieStore: getAll() method

name Optional

A string with the name of a cookie.

Or

options Optional

An object containing:

name

A string with the name of a cookie.

url

A string with the URL of a cookie.

A Promise that resolves with an array of objects representing cookies that match the given name or options.

Each object contains the following properties:

domain

A string containing the domain of the cookie.

expires

A timestamp, given as Unix time in milliseconds, containing the expiration date of the cookie.

name

A string containing the name of the cookie.

partitioned

A boolean indicating whether the cookie is a partitioned cookie (true) or not (false). See Cookies Having Independent Partitioned State (CHIPS) for more information.

path

A string containing the path of the cookie.

sameSite

One of the following SameSite values:

"strict"

Cookies will only be sent in a first-party context and not be sent with requests initiated by third party websites.

"lax"

Cookies are not sent on normal cross-site subrequests (for example to load images or frames into a third party site), but are sent when a user is navigating within the origin site (i.e. when following a link).

"none"

Cookies will be sent in all contexts.

secure

A boolean value indicating whether the cookie is to be used in secure contexts only (true) or not (false).

value

A string containing the value of the cookie.

SecurityError DOMException

Thrown if the origin does not serialize to a URL.

TypeError

Thrown if:

• The url option is present and is not equal with the creation URL, if in main thread.
• The url option is present and its origin is not the same as the origin of the creation URL.
• Querying cookies represented by the given name or options fails.

In this example, we use getAll() with no parameters. This returns all of the cookies for this context as an array of objects.

const cookies = await cookieStore.getAll();

if (cookies.length > 0) {
  console.log(cookies);
} else {
  console.log("Cookie not found");
}