CookieStore

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 CookieStore-Schnittstelle der Cookie Store API bietet Methoden zum asynchronen Abrufen und Setzen von Cookies, entweder von einer Seite oder einem Service Worker aus.

Der CookieStore wird über Attribute im globalen Bereich in einem Window oder ServiceWorkerGlobalScope-Kontext aufgerufen. Daher gibt es keinen Konstruktor.

Instanzmethoden

CookieStore.delete(): Die delete()-Methode löscht ein Cookie mit dem angegebenen name oder options-Objekt. Sie gibt ein Promise zurück, das aufgelöst wird, wenn das Löschen abgeschlossen ist.
CookieStore.get(): Die get()-Methode erhält ein einzelnes Cookie mit dem angegebenen name oder options-Objekt. Sie gibt ein Promise zurück, das mit den Details eines einzelnen Cookies aufgelöst wird.
CookieStore.getAll(): Die getAll()-Methode erhält alle übereinstimmenden Cookies. Sie gibt ein Promise zurück, das mit einer Liste von Cookies aufgelöst wird.
CookieStore.set(): Die set()-Methode setzt ein Cookie mit dem angegebenen name und value oder options-Objekt. Sie gibt ein Promise zurück, das aufgelöst wird, wenn das Cookie gesetzt ist.

Ereignisse

change: Das change-Ereignis wird ausgelöst, wenn eine Änderung an einem Cookie vorgenommen wird.

Beispiele

In diesem Beispiel setzen wir ein Cookie und schreiben eine Rückmeldung in die Konsole, ob der Vorgang erfolgreich war oder fehlgeschlagen ist.

const day = 24 * 60 * 60 * 1000;

cookieStore
  .set({
    name: "cookie1",
    value: "cookie1-value",
    expires: Date.now() + day,
    domain: "example.com",
  })
  .then(
    () => {
      console.log("It worked!");
    },
    (reason) => {
      console.error("It failed: ", reason);
    },
  );

Spezifikationen

Specification
Cookie Store API # CookieStore

Browser-Kompatibilität

BCD tables only load in the browser