CookieStore: get() method

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Service Workers.

The get() method of the CookieStore interface returns a single cookie with the given name or options object. The method will return the first matching cookie for the passed parameters.




This method requires one of the following:

name Optional

A string with the name of a cookie.


options Optional

An object containing:


A string with the name of a cookie.


A string with the URL of a cookie.

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 an object representing the first cookie matching the submitted name or options. This object contains the following properties:


A string containing the domain of the cookie.


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


A string containing the name of the cookie.


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


A string containing the path of the cookie.


One of the following SameSite values:


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


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


Cookies will be sent in all contexts.


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


A string containing the value of the cookie.


SecurityError DOMException

Thrown if the origin does not serialize to a URL.


Thrown if:

  • The options parameter is an empty object.
  • 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 return a cookie named "cookie1". If the cookie is found the result of the Promise is an object containing the details of a single cookie.

const cookie = await cookieStore.get("cookie1");

if (cookie) {
} else {
  console.log("Cookie not found");


Cookie Store API
# dom-cookiestore-get

Browser compatibility

BCD tables only load in the browser