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: Diese Funktion ist in Service Workers verfügbar.
Die set()
-Methode des CookieStore
-Interfaces setzt ein Cookie mit dem gegebenen name
und value
oder einem options
-Objekt.
Syntax
set(name, value)
set(options)
Parameter
Diese Methode erfordert einen der folgenden Parameter:
name
Optional-
Ein String mit dem Namen des Cookies.
value
Optional-
Ein String mit dem Wert des Cookies.
Oder
options
Optional-
Ein Objekt, das Folgendes enthält:
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 auf
false
gesetzt ist. Wenn auftrue
gesetzt, wird das gesetzte Cookie ein partitioniertes Cookie sein. Weitere Informationen finden Sie unter Cookies Having Independent Partitioned State (CHIPS). path
Optional-
Ein String, der den Pfad des Cookies enthält. Standardmäßig
/
. sameSite
Optional-
Einer der folgenden
SameSite
-Werte:"strict"
,"lax"
oder"none"
. value
-
Ein String mit dem Wert des Cookies.
Hinweis:
Während die Werte hier gesetzt werden können und intern verwendet werden, geben einige Browser nur name
und value
-Optionen von CookieStore.get()
und CookieStore.getAll()
zurück.
Rückgabewert
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 gegebenen
name
undvalue
oderoptions
fehlschlägt.
Beispiele
Setzen eines Cookies mit Name und Wert
Dieses Beispiel setzt ein Cookie durch Übergeben eines name
und value
von "cookie1" und "cookie1-value", entsprechend.
Die anderen Eigenschaften des Cookies werden mit Standardwerten gesetzt, wie im options
-Parameter definiert.
Der Code wartet zuerst darauf, dass das Cookie gesetzt wird: da diese Operation fehlschlagen kann, wird sie in einem try...catch
-Block durchgeführt und Fehler werden in die Konsole protokolliert.
Dann wird das gerade gesetzte Cookie abgerufen und protokolliert.
async function cookieTest() {
// Set cookie: passing name and value
try {
await cookieStore.set("cookie1", "cookie1-value");
} catch (error) {
console.log(`Error setting cookie1: ${error}`);
}
// Get the cookie and log its values
const cookie = await cookieStore.get("cookie1");
console.log(cookie);
}
Setzen eines Cookies mit Optionen
Dieses Beispiel setzt ein Cookie durch Übergeben eines options
-Objekts mit name
, value
, expires
und partitioned
.
Der Code wartet zuerst darauf, dass das Cookie gesetzt wird: da diese Operation fehlschlagen kann, wird sie in einem try...catch
-Block durchgeführt und Fehler werden in die Konsole protokolliert.
Dann wird das gerade gesetzte Cookie abgerufen und protokolliert.
async function cookieTest() {
const day = 24 * 60 * 60 * 1000;
const cookieName = "cookie2";
try {
// Set cookie: passing options
await cookieStore.set({
name: cookieName,
value: `${cookieName}-value`,
expires: Date.now() + day,
partitioned: true,
});
} catch (error) {
log(`Error setting ${cookieName}: ${error}`);
console.log(error);
}
// Log the new cookie
const cookie = await cookieStore.get(cookieName);
console.log(cookie);
}
Spezifikationen
Specification |
---|
Cookie Store API # dom-cookiestore-set |