CookieStore: get()-Methode

Baseline 2025 *

Newly available

Since ⁨June 2025⁩, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

* Some parts of this feature may have varying levels of support.

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 mit einem einzelnen Cookie aufgelöst wird, das dem angegebenen name oder options-Objekt entspricht. Die Methode gibt das erste Cookie zurück, das übereinstimmt.

Syntax

get(name)
get(options)

Parameter

Diese Methode erfordert eine der folgenden Angaben:

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 Modifikation eines Cookies, das unter einer bestimmten URL zugeordnet ist. Service Worker können Cookies erhalten, die an jede URL unter ihrem Gültigkeitsbereich gesendet würden. In einem Dokument können Sie nur die Cookies der aktuellen URL erhalten, sodass die einzige gültige URL im Kontext eines Dokuments die URL des Dokuments ist.

Rückgabewert

Ein Promise, das mit einem Objekt aufgelöst wird, das das erste Cookie darstellt, das dem angegebenen 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 Experimentell Nicht standardisiert: Ein String, der die Domain des Cookies enthält.
expires Experimentell Nicht standardisiert: Ein Zeitstempel, angegeben als Unix-Zeit in Millisekunden, der das Ablaufdatum des Cookies enthält.
name Experimentell Nicht standardisiert: Ein String, der den Namen des Cookies enthält.
partitioned Experimentell Nicht standardisiert: Ein boolescher Wert, der angibt, ob das Cookie ein partitioniertes Cookie ist (true) oder nicht (false). Siehe Cookies Having Independent Partitioned State (CHIPS) für weitere Informationen.
path Experimentell Nicht standardisiert: Ein String, der den Pfad des Cookies enthält.
sameSite Experimentell Nicht standardisiert: Einer der folgenden SameSite-Werte: "strict", "lax" oder "none".
secure Experimentell Nicht standardisiert: Ein boolescher Wert, der angibt, ob das Cookie nur in sicheren Kontexten verwendet werden soll (true) oder nicht (false).
value Experimentell Nicht standardisiert: Ein String, der den Wert des Cookies enthält.

Ausnahmen

SecurityError DOMException

Wird ausgelöst, wenn der Ursprung nicht zu einer URL serialisiert werden kann.

TypeError

Wird ausgelöst, wenn:

Der options-Parameter 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.
Die Abfrage der durch den angegebenen name oder options dargestellten Cookies fehlschlägt.

Beispiele

Ein Cookie nach Namen abrufen

Dieses Beispiel zeigt, wie Sie ein bestimmtes Cookie nach Namen abrufen können.

Der Code erstellt zunächst ein Cookie mit dem Namen "cookie1" mit CookieStore.set() und protokolliert dabei eventuelle Fehler in der Konsole. Dann wartet es auf get(), um Informationen über dasselbe Cookie abzurufen. Wenn das zurückgegebene Promise mit einem Objekt aufgelöst wird, protokollieren wir das Cookie: ansonsten 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

Specification
Cookie Store API # dom-cookiestore-get

Browser-Kompatibilität

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden