CookieStore: get() Methode
Baseline
2025
*
Neu verfügbar
Seit June 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 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 des CookieStore-Interfaces gibt ein Promise zurück, das mit einem einzelnen 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 Modifikation eines Cookies, das unter einer bestimmten URL festgelegt ist. Service Worker können Cookies abrufen, die an jede URL unter ihrem Geltungsbereich gesendet würden. Aus einem Dokument können Sie nur die Cookies an der aktuellen URL abrufen, sodass die einzige gültige URL in einem Dokumentkontext die URL des Dokuments ist.
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 für eine Übereinstimmung zurückgegebene 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 boolescher Wert, der angibt, ob das Cookie ein partitioniertes Cookie ist (
true) oder nicht (false). Weitere Informationen finden Sie unter Cookies mit unabhängigem partiellem Zustand (CHIPS). path-
Ein String, der den Pfad des Cookies enthält.
sameSite-
Einer der folgenden
SameSiteWerte:"strict","lax", oder"none". secure-
Ein boolescher 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
SecurityErrorDOMException-
Ausgelöst, wenn der Ursprung nicht in eine URL serialisiert wird.
TypeError-
Ausgelöst, wenn:
- Der
optionsParameter ein leeres Objekt ist. - Die Methode im Hauptthread 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 von Cookies, die durch den angegebenen
nameoderoptionsrepräsentiert werden, fehlschlägt.
- Der
Beispiele
Ein Cookie nach Namen abrufen
Dieses Beispiel zeigt, wie man ein bestimmtes Cookie nach Namen abruft.
Der Code erstellt zunächst ein Cookie namens "cookie1" mit CookieStore.set() und protokolliert eventuelle Fehler in der Konsole.
Dann wartet er auf get(), um Informationen zu diesem gleichen 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 |