SharedStorage: Methode set()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Die set()-Methode der SharedStorage-Schnittstelle speichert entweder ein neues Schlüssel-Wert-Paar im Shared Storage des aktuellen Ursprungs oder aktualisiert ein bestehendes Paar.

Syntax

js
set(key, value)
set(key, value, options)

Parameter

key

Ein String, der den Schlüssel im Schlüssel-Wert-Paar darstellt, den Sie hinzufügen oder aktualisieren möchten.

value

Ein String, der den Wert darstellt, den Sie hinzufügen oder aktualisieren möchten.

options Optional

Ein Optionsobjekt, das die folgenden Eigenschaften enthält:

ignoreIfPresent

Ein boolescher Wert. Der Wert true führt dazu, dass der Setzvorgang abgebrochen wird, wenn bereits ein Schlüssel-Wert-Paar mit dem angegebenen key existiert. Der Standardwert false führt dazu, dass der bestehende Wert überschrieben wird.

Rückgabewert

Ein Promise, das mit undefined erfüllt wird.

Ausnahmen

  • Das Promise wird mit einem TypeError abgelehnt, wenn:
    • Der erstellte Eintrag nicht erfolgreich in der Datenbank gespeichert wurde, weil der Shared Storage nicht verfügbar ist (zum Beispiel, wenn er durch eine Browsereinstellung deaktiviert ist).
    • key und/oder value die vom Browser festgelegte maximale Länge überschreiten.
    • Die aufrufende Site die Shared Storage API nicht in einem erfolgreichen Anmeldeprozess für die Privacy Sandbox integriert hat.
  • Im Fall von WorkletSharedStorage wird das Promise mit einem TypeError abgelehnt, wenn das Worklet-Modul nicht mit SharedStorageWorklet.addModule() hinzugefügt wurde.

Hinweis: Im Fall von WindowSharedStorage wird, wenn der set()-Vorgang aus einem anderen Grund als nicht verfügbarem Shared Storage nicht erfolgreich in die Datenbank schreibt, kein Fehler ausgelöst — der Vorgang wird trotzdem mit undefined erfüllt.

Beispiele

js
window.sharedStorage
  .set("ab-testing-group", "0", {
    ignoreIfPresent: true,
  })
  .then(console.log("Set operation completed"));

Spezifikationen

Specification
Shared Storage API
# dom-sharedstorage-set

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch