CookieStore: Methode getAll()

Die getAll() Methode der CookieStore Schnittstelle gibt ein Promise zurück, das mit einem Array von Cookies aufgelöst wird, die dem übergebenen name oder options entsprechen. Werden keine Parameter übergeben, werden alle Cookies für den aktuellen Kontext zurückgegeben.

Syntax

getAll()
getAll(name)
getAll(options)

Parameter

name Optional

Ein String, der den Namen eines Cookies enthält.

Oder

options Optional

Ein Objekt, das Folgendes enthält:

name

Ein String, der den Namen eines Cookies enthält.

url

Ein String, der die URL eines Cookies enthält.

Rückgabewert

Ein Promise, das mit einem Array von Objekten aufgelöst wird, die Cookies repräsentieren, die dem angegebenen name oder options entsprechen.

Jedes Objekt enthält die folgenden Eigenschaften:

domain

Ein String, der die Domäne des Cookies enthält.

expires

Ein Zeitstempel in 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 Having Independent Partitioned State (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

Wird ausgelöst, wenn:

• Die Methode im Haupt-Thread aufgerufen wird und die url-Option angegeben wird, die jedoch nicht mit der URL des aktuellen Fensters übereinstimmt.
• Die Methode in einem Worker aufgerufen wird und die url-Option angegeben wird, die jedoch nicht mit dem Ursprung des Workers übereinstimmt.
• Die Abfrage von Cookies, die durch den gegebenen name oder options dargestellt werden, fehlschlägt.

Beispiele

Alle Cookies für diesen Kontext abrufen

Dieses Beispiel zeigt, wie alle Cookies im aktuellen Kontext abgerufen werden.

Zuerst definieren wir setTestCookies(), das die Test-Cookies "cookie1" und "cookie2" erstellt und dabei Fehler protokolliert.

async function setTestCookies() {
 // Set two cookies
 try {
 await cookieStore.set("cookie1", "cookie1-value");
 } catch (error) {
 console.log(`Error setting cookie1: ${error}`);
 }
 try {
 await cookieStore.set("cookie2", "cookie2-value");
 } catch (error) {
 console.log(`Error setting cookie2: ${error}`);
 }
}

Die cookieTest() Methode ruft setTestCookies() auf und wartet dann auf getAll(). Das gibt ein Promise zurück, das mit allen Cookies für diesen Kontext als Array von Objekten oder einem leeren Array, falls keine Cookies vorhanden sind, aufgelöst wird. Wenn das zurückgegebene Promise mit einem Array von Cookie-Informationen aufgelöst wird, iterieren wir über das Array und protokollieren jedes Cookie ("cookie1" und "cookie2").

async function cookieTest() {
 // Set our test cookies
 await setTestCookies();
 // Get all cookies
 const cookies = await cookieStore.getAll();
 // Iterate the cookies, or log that none were found
 if (cookies.length > 0) {
 console.log(`Found cookies: ${cookies.length}:`);
 cookies.forEach((cookie) => console.log(cookie));
 } else {
 console.log("Cookies not found");
 }
}

Spezifikationen

Browser-Kompatibilität