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 den options
entsprechen. Wenn keine Parameter übergeben werden, 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:
Hinweis:
Die url
-Option ermöglicht die Modifikation eines Cookies, das unter einer bestimmten URL gesichert ist. Service Worker können Cookies erhalten, die an jede URL in ihrem Geltungsbereich gesendet werden 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 Dokumentkontext die URL des Dokuments.
Rückgabewert
Ein Promise
, das mit einem Array von Objekten aufgelöst wird, die Cookies darstellen, die dem gegebenen name
oder den options
entsprechen.
Jedes Objekt enthält die folgenden Eigenschaften:
domain
-
Ein String, der die Domäne 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ängigen partitionierten Zuständen (CHIPS). path
-
Ein String, der den Pfad des Cookies enthält.
sameSite
-
Einer der folgenden
SameSite
-Werte:"strict"
-
Cookies werden nur in einem erstparteien Kontext gesendet und nicht mit Anfragen von Drittanbieter-Websites.
"lax"
-
Cookies werden bei normalen Cross-Site-Unteranfragen (z. B. beim Laden von Bildern oder Frames in eine Drittanbieterseite) nicht gesendet, werden jedoch gesendet, wenn ein Benutzer innerhalb der Herkunftsseite 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 serialisierbar ist.
TypeError
-
Wird ausgelöst, wenn:
- Die
url
-Option vorhanden ist und nicht mit der Erstellung-URL gleich ist, wenn im Hauptthread. - Das
url
-Option vorhanden ist und ihr Ursprung nicht derselbe ist wie der Ursprung der Erstellung-URL. - Das Abfragen der durch den gegebenen
name
oderoptions
dargestellten Cookies fehlschlägt.
- Die
Beispiele
In diesem Beispiel verwenden wir getAll()
ohne Parameter. Dies gibt alle Cookies für diesen Kontext als ein 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
Report problems with this compatibility data on GitHubdesktop | mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getAll | ||||||||||||
domain in return value | ||||||||||||
expires in return value | ||||||||||||
name in return value | ||||||||||||
partitioned in return value | ||||||||||||
path in return value | ||||||||||||
sameSite in return value | ||||||||||||
secure in return value | ||||||||||||
value in return value |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support
- Experimental. Expect behavior to change in the future.