CookieStore: get()-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 get()-Methode der CookieStore-Schnittstelle gibt ein Promise zurück, das sich zu einem einzelnen Cookie auflöst, das entweder dem angegebenen name oder dem options-Objekt entspricht. Die Methode gibt das erste übereinstimmende Cookie zurück.

Syntax

get(name)
get(options)

Parameter

Diese Methode erfordert einen der folgenden:

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 das Ändern eines Cookies mit Gültigkeitsbereich unter einer bestimmten URL. Service-Arbeiter können Cookies erhalten, die an jede URL innerhalb ihres Bereichs 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 Dokumentkontext die URL des Dokuments.

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 passendes Cookie vorhanden ist.

Das zurückgegebene Objekt für eine Übereinstimmung 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 (true) ist oder nicht (false). Weitere Informationen finden Sie unter Cookies mit unabhängigem partitioniertem Zustand (CHIPS).
path: Ein String, der den Pfad des Cookies enthält.
sameSite: Einer der folgenden SameSite-Werte: "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

SecurityError DOMException

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

TypeError

Ausgelöst, wenn:

Der options-Parameter ein leeres Objekt ist.
Die Methode im Hauptthread aufgerufen wird und die url-Option angegeben, 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 name oder options dargestellt werden, fehlschlägt.

Beispiele

Ein Cookie nach Namen abrufen

Dieses Beispiel zeigt, wie ein bestimmtes Cookie nach Name abgerufen wird.

Der Code erstellt zuerst ein Cookie namens "cookie1" mit CookieStore.set() und protokolliert eventuelle 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 passendes 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