CookieStore: set()-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: Dieses Feature ist verfügbar in Service Workers.

Die set()-Methode des CookieStore-Interfaces setzt ein Cookie mit dem angegebenen name und value oder einem options-Objekt.

Syntax

js
set(name, value)
set(options)

Parameter

Diese Methode erfordert eines der folgenden:

name Optional

Ein String mit dem Namen des Cookies.

value Optional

Ein String mit dem Wert des Cookies.

Oder

options Optional

Ein Objekt mit den folgenden Eigenschaften:

domain Optional

Ein String, der die Domain des Cookies enthält. Standardmäßig null.

expires Optional

Ein Zeitstempel, angegeben als Unix-Zeit in Millisekunden, der das Ablaufdatum des Cookies enthält. Standardmäßig null.

name

Ein String mit dem Namen eines Cookies.

partitioned Optional

Ein boolescher Wert, der standardmäßig false ist. Wenn auf true gesetzt, wird das gesetzte Cookie ein partitioniertes Cookie sein. Weitere Informationen finden Sie unter Cookies mit unabhängigem partitionierten Zustand (CHIPS).

path Optional

Ein String, der den Pfad des Cookies enthält. Standardmäßig /.

sameSite Optional

Einer der folgenden SameSite-Werte:

"strict"

Cookies werden nur in einem Erstparteikontext gesendet und nicht zusammen mit Anfragen, die von Drittanbieter-Websites initiiert werden. Dies ist der Standard.

"lax"

Cookies werden nicht bei normalen Cross-Site-Subanfragen gesendet (zum Beispiel zum Laden von Bildern oder Frames in eine Drittanbieter-Seite), jedoch gesendet, wenn ein Benutzer zur Ursprungsseite navigiert (d.h. wenn er einem Link folgt).

"none"

Cookies werden in allen Kontexten gesendet.

value

Ein String mit dem Wert des Cookies.

Rückgabewert

Ein Promise, das mit undefined aufgelöst wird, wenn das Setzen des Cookies abgeschlossen ist.

Ausnahmen

SecurityError DOMException

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

TypeError

Wird ausgelöst, wenn das Setzen des Cookies mit dem angegebenen name und value oder options fehlschlägt.

Beispiele

Das folgende Beispiel setzt ein Cookie, indem ein Objekt mit name, value, expires und domain übergeben wird.

js
const day = 24 * 60 * 60 * 1000;

cookieStore.set({
  name: "cookie1",
  value: "cookie1-value",
  expires: Date.now() + day,
  domain: "example.com",
});

Spezifikationen

Specification
Cookie Store API
# dom-cookiestore-set

Browser-Kompatibilität

BCD tables only load in the browser