SharedStorage: set()-Methode
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 vor der Verwendung auf produktiven Webseiten.
Die set()-Methode der SharedStorage-Schnittstelle speichert entweder ein neues Schlüssel-Wert-Paar im geteilten 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, den 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 der Setzvorgang abgebrochen wird, wenn ein Schlüssel-Wert-Paar mit dem angegebenenkeybereits existiert. Der Standardwertfalseführt dazu, dass der Setzvorgang den vorherigen Wert überschreibt.
Rückgabewert
Ein Promise, das mit undefined erfüllt wird.
Ausnahmen
- Das
Promisewird mit einemTypeErrorabgelehnt, wenn:- Der erstellte Eintrag aufgrund einer nicht verfügbaren geteilten Speicherung nicht erfolgreich in der Datenbank gespeichert wurde (zum Beispiel, wenn diese durch eine Browsereinstellung deaktiviert ist).
keyund/odervaluedie vom Browser definierte maximale Länge überschreiten.- Die aufrufende Website die Shared Storage API nicht in einem erfolgreichen Anmeldeprozess für die Datenschutzeinstellungen aufgenommen hat.
- Im Fall von
WorkletSharedStoragewird dasPromisemit einemTypeErrorabgelehnt, wenn das Worklet-Modul nicht mitSharedStorageWorklet.addModule()hinzugefügt wurde.
Hinweis:
Im Fall von WindowSharedStorage wird, wenn der set()-Vorgang aus einem anderen Grund als der Nichtverfügbarkeit des geteilten Speichers nicht erfolgreich in die Datenbank geschrieben wird, kein Fehler ausgelöst — der Vorgang 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 |
Browser-Kompatibilität
Loading…