CookieStore: getAll()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Service Workers verfügbar.

Die getAll()-Methode der CookieStore-Schnittstelle gibt eine Liste von Cookies zurück, die dem übergebenen name oder options entsprechen. Werden keine Parameter übergeben, werden alle Cookies für den aktuellen Kontext zurückgegeben.

Syntax

getAll(name)
getAll(options)

Parameter

name Optional: Ein String mit dem Namen eines Cookies.

Oder

options Optional

Ein Objekt, das Folgendes enthält:

name: Ein String mit dem Namen eines Cookies.
url: Ein String mit der URL eines Cookies.

Hinweis: Die url-Option ermöglicht die Änderung eines Cookies, das unter einer bestimmten URL liegt. Service-Worker können Cookies erhalten, die an jede URL unter ihrem Geltungsbereich gesendet würden. Aus einem Dokument heraus können Sie nur die Cookies an der aktuellen URL erhalten, daher ist die einzige gültige URL im Dokumentenkontext die URL des Dokuments.

Rückgabewert

Ein Promise, das bei Erfolg mit einem Array von Objekten aufgelöst wird, die die Cookies darstellen, die dem gegebenen name oder options entsprechen.

Jedes Objekt enthält die folgenden Eigenschaften:

domain

Ein String, der die Domain des Cookies enthält.

expires

Ein Zeitstempel, angegeben als Unix-Zeit in Millisekunden, der das Ablaufdatum des Cookies enthält.

name

Ein String, der den Namen des Cookies enthält.

partitioned

Ein Boolean, der angibt, ob das Cookie ein partitioniertes Cookie (true) ist oder nicht (false). Weitere Informationen finden Sie unter Cookies mit unabhängiger partitionierter Zustandsverwaltung (CHIPS).

path

Ein String, der den Pfad des Cookies enthält.

sameSite

Einer der folgenden SameSite-Werte:

"strict": Cookies werden nur in einem First-Party-Kontext gesendet und nicht mit Anfragen, die von Drittanbieter-Websites initiiert wurden.
"lax": Cookies werden bei normalen Cross-Site-Subrequests nicht gesendet (zum Beispiel zum Laden von Bildern oder Frames auf eine Drittanbieter-Website), aber sie werden gesendet, wenn ein Benutzer innerhalb der Ursprungsseite navigiert (z.B. beim Folgen eines Links).
"none": Cookies werden in allen Kontexten gesendet.

secure

Ein Boolean-Wert, der angibt, ob das Cookie nur in sicheren Kontexten verwendet werden soll (true) oder nicht (false).

value

Ein String, der den Wert des Cookies enthält.

Ausnahmen

SecurityError DOMException

Wird ausgelöst, wenn der Ursprung nicht in eine URL serialisiert werden kann.

TypeError

Wird ausgelöst, wenn:

Die url-Option vorhanden ist und nicht mit der Erstellungs-URL übereinstimmt, wenn im Hauptthread.
Die url-Option vorhanden ist und ihr Ursprung nicht derselbe wie der Ursprung der Erstellungs-URL ist.
Die Abfrage von Cookies, die durch den gegebenen name oder options dargestellt werden, fehlschlägt.

Beispiele

In diesem Beispiel verwenden wir getAll() ohne Parameter. Dies gibt alle Cookies für diesen Kontext als Array von Objekten zurück.

const cookies = await cookieStore.getAll();

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

Spezifikationen

Specification
Cookie Store API # dom-cookiestore-getall

Browser-Kompatibilität

BCD tables only load in the browser