SharedStorage: set()-Methode
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.
Die set()-Methode der SharedStorage-Schnittstelle speichert entweder ein neues Schlüssel-Wert-Paar im gemeinsam genutzten Speicher des aktuellen Ursprungs oder aktualisiert ein bestehendes.
Syntax
set(key, value)
set(key, value, options)
Parameter
key-
Ein String, der den Schlüssel im Schlüssel-Wert-Paar darstellt, das Sie hinzufügen oder aktualisieren möchten.
value-
Ein String, der den Wert darstellt, den Sie hinzufügen oder aktualisieren möchten.
optionsOptional-
Ein Optionsobjekt, das die folgenden Eigenschaften enthält:
ignoreIfPresent-
Ein boolescher Wert. Der Wert
truebewirkt, dass die set-Operation abgebrochen wird, wenn ein Schlüssel-Wert-Paar mit dem angegebenenkeybereits existiert. Der Standardwertfalsebewirkt, dass die set-Operation den vorherigen Wert überschreibt.
Rückgabewert
Ein Promise, das mit undefined erfüllt wird.
Ausnahmen
- Das
Promisewird mit einemTypeErrorabgelehnt, wenn:- Der erstellte Eintrag aufgrund der Nichtverfügbarkeit des gemeinsam genutzten Speichers nicht erfolgreich in der Datenbank gespeichert wurde (zum Beispiel, wenn er durch eine Browsereinstellung deaktiviert ist).
keyund/odervaluedie vom Browser festgelegte maximale Länge überschreiten.- Die aufrufende Website die Shared Storage API nicht in einem erfolgreichen Privacy Sandbox-Anmeldeprozess eingeschlossen hat.
- Im Fall von
WorkletSharedStoragewird dasPromisemit einemTypeErrorabgelehnt, wenn das Worklet-Modul nicht mitSharedStorageWorklet.addModule()hinzugefügt wurde.
Hinweis:
Im Fall von WindowSharedStorage, wenn die set()-Operation aus einem anderen Grund als der Nichtverfügbarkeit des gemeinsam genutzten Speichers nicht erfolgreich in die Datenbank schreibt, wird kein Fehler ausgelöst — die Operation wird trotzdem mit undefined erfüllt.
Beispiele
window.sharedStorage
.set("ab-testing-group", "0", {
ignoreIfPresent: true,
})
.then(() => console.log("Set operation completed"));
Spezifikationen
| Specification |
|---|
| Shared Storage API # dom-sharedstorage-set |