CookieStore: get() Methode
Baseline
2025
*
Neu verfügbar
Seit Juni 2025 funktioniert diese Funktion auf aktuellen Geräten und in aktuellen Browserversionen. Auf älteren Geräten oder in älteren Browsern funktioniert sie möglicherweise nicht.
Want more browser support for this feature? Tell us why.
* Einige Teile dieser Funktion werden möglicherweise unterschiedlich gut unterstützt.
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 get() Methode der CookieStore-Schnittstelle gibt ein Promise zurück, das auf ein einzelnes Cookie aufgelöst wird, das dem angegebenen name oder options Objekt entspricht. Die Methode gibt das erste übereinstimmende Cookie zurück.
Syntax
get(name)
get(options)
Parameter
Diese Methode erfordert einen der folgenden Parameter:
nameOptional-
Ein String mit dem Namen eines Cookies.
Oder
optionsOptional-
Ein Objekt, das Folgendes enthält:
Hinweis:
Die url-Option ermöglicht die Änderung eines Cookies, das unter einer bestimmten URL definiert ist. Service Worker können Cookies abrufen, die an jede URL unter ihrem Bereich gesendet würden. Aus einem Dokument können Sie nur die Cookies an der aktuellen URL abrufen, daher ist die einzige gültige URL in einem Dokumentkontext die URL des Dokuments.
Rückgabewert
Ein Promise, das mit einem Objekt aufgelöst wird, das das erste Cookie darstellt, das dem übermittelten name oder options entspricht, oder null, wenn kein übereinstimmendes Cookie vorhanden ist.
Das zurückgegebene Objekt für eine Übereinstimmung enthält die folgenden Eigenschaften:
name-
Ein String, der den Namen des Cookies enthält.
value-
Ein String, der den Wert des Cookies enthält.
Die folgenden Eigenschaften sind nicht standardisiert und sollten nicht verwendet werden:
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.
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","lax"oder"none". secure-
Ein Boolean-Wert, der angibt, ob das Cookie nur in sicheren Kontexten verwendet werden soll (
true) oder nicht (false).
Ausnahmen
SecurityErrorDOMException-
Wird ausgelöst, wenn der Ursprung nicht in eine URL serialisiert werden kann.
TypeError-
Wird ausgelöst, wenn:
- Der
options-Parameter ein leeres Objekt ist. - Die Methode im Haupt-Thread aufgerufen wird, und die
url-Option angegeben ist, aber nicht mit der URL des aktuellen Fensters übereinstimmt. - Die Methode in einem Worker aufgerufen wird und die
url-Option angegeben ist, aber nicht mit dem Ursprung des Workers übereinstimmt. - Das Abfragen der Cookies, die durch den angegebenen
nameoderoptionsdargestellt werden, fehlschlägt.
- Der
Beispiele
Abrufen eines Cookies nach Name
Dieses Beispiel zeigt, wie ein bestimmtes Cookie nach Name abgerufen wird.
Der Code erstellt zunächst ein Cookie mit dem Namen "cookie1" mithilfe der CookieStore.set()-Methode und protokolliert dabei aufgetretene Fehler in der Konsole. Anschließend wartet er auf get(), um Informationen über dasselbe Cookie abzurufen. Wenn das zurückgegebene Promise mit einem Objekt aufgelöst wird, protokollieren wir das Cookie; andernfalls protokollieren wir, dass kein übereinstimmendes Cookie gefunden wurde.
async function cookieTest() {
// Set test cookie
try {
await cookieStore.set("cookie1", "cookie1-value");
} catch (error) {
console.log(`Error setting cookie1: ${error}`);
}
// Get cookie, specifying name
const cookie = await cookieStore.get("cookie1");
if (cookie) {
console.log(cookie);
} else {
console.log("cookie1: Cookie not found");
}
}
cookieTest();
Spezifikationen
| Spezifikation |
|---|
| Cookie Store API # dom-cookiestore-get |