index.html

---
title: CookieStore.getAll()
slug: Web/API/CookieStore/getAll
tags:
  - API
  - Method
  - Reference
  - getAll()
  - CookieStore
browser-compat: api.CookieStore.getAll
---
<div>{{securecontext_header}}{{DefaultAPISidebar("Cookie Store API")}}</div>

<p>The <strong><code>getAll()</code></strong> method of the {{domxref("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.</p>

<h2 id="Syntax">Syntax</h2>

<pre class="syntaxbox">var <var>list</var> = cookieStore.getAll(<var>name</var>);
var <var>list</var> = cookieStore.getAll(<var>options</var>);</pre>

<h3 id="Parameters">Parameters</h3>

<dl>
  <dt><code>name</code>{{Optional_Inline}}</dt>
  <dd>A {{domxref("USVString")}} with the name of a cookie.</dd>
  <dt><code>options</code>{{Optional_Inline}}</dt>
  <dd>An object containing:
    <dl>
      <dt><code>name</code></dt>
      <dd>A {{domxref("USVString")}} with the name of a cookie.</dd>
      <dt><code>url</code></dt>
      <dd>A {{domxref("USVString")}} with the url of a cookie.</dd>
    </dl>
  </dd>
</dl>

<div class="notecard note">
  <p><strong>Note:</strong> The <code>url</code> 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.</p>
</div>

<h3 id="Returns">Return value</h3>

<p>A {{jsxref("Promise")}} that resolves with a list of cookies for the given name or options.</p>

<h3 id="Exceptions">Exceptions</h3>

<dl>
  <dt>{{jsxref("TypeError")}}</dt>
  <dd>Thrown if getting the cookie or cookies represented by the given <code>name</code> or <code>options</code> fails.</dd>
</dl>

<h2 id="Examples">Examples</h2>

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

<pre class="brush:js">let cookies = cookieStore.getAll();
if (cookies) {
  console.log(cookies);
} else {
  console.log('Cookie not found');
}</pre>

<h2 id="Specifications">Specifications</h2>

{{Specifications}}

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat}}</p>