StorageArea.set()

Speichert ein oder mehrere Elemente im Speicherbereich oder aktualisiert gespeicherte Elemente.

Wenn Sie einen Wert mit dieser API speichern oder aktualisieren, wird das storage.onChanged-Ereignis ausgelöst.

Beachten Sie, dass beim Speichern von Elementen im sync-Speicherbereich der Browser Quoten für die Menge der Daten durchsetzt, die jede Erweiterung speichern kann. Siehe Speicherquoten für Sync-Daten.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

let settingItem = browser.storage.<storageType>.set(
  keys             // object
)

Wobei <storageType> einer der beschreibbaren Speicherarten ist — storage.local, storage.session oder storage.sync.

Parameter

keys

Ein Objekt, das ein oder mehrere zu speichernde Schlüssel/Wert-Paare enthält. Wenn ein Element im Speicher ist, wird sein Wert aktualisiert.

Werte können primitiv (wie eine Zahl, ein Boolean oder ein String), Array oder Object Typen sein.

Es ist im Allgemeinen nicht möglich, andere Typen wie Function, Date, RegExp, Set, Map, ArrayBuffer usw. zu speichern. Einige nicht unterstützte Typen werden als leeres Objekt wiederhergestellt, während andere dazu führen, dass set() einen Fehler auslöst. Das Verhalten ist browser-spezifisch.

Hinweis: Wenn Sie Schlüssel aus dem Speicher entfernen möchten, verwenden Sie storage.storageArea.remove. Wenn Sie einen Wert mit einem leeren Wert überschreiben möchten, verwenden Sie null, d.h. key: null.

Rückgabewert

Ein Promise, das bei Erfolg der Operation ohne Argumente erfüllt wird. Wenn die Operation fehlschlägt, wird das Promise mit einer Fehlermeldung abgelehnt.

Beispiele

function setItem() {
  console.log("OK");
}

function gotKitten(item) {
  console.log(`${item.kitten.name} has ${item.kitten.eyeCount} eyes`);
}

function gotMonster(item) {
  console.log(`${item.monster.name} has ${item.monster.eyeCount} eyes`);
}

function onError(error) {
  console.log(error);
}

// define 2 objects
let monster = {
  name: "Kraken",
  tentacles: true,
  eyeCount: 10,
};

let kitten = {
  name: "Moggy",
  tentacles: false,
  eyeCount: 2,
};

// store the objects
browser.storage.local.set({ kitten, monster }).then(setItem, onError);

browser.storage.local.get("kitten").then(gotKitten, onError);
browser.storage.local.get("monster").then(gotMonster, onError);

Browser-Kompatibilität

Hinweis: Diese API basiert auf der chrome.storage-API von Chromium. Diese Dokumentation stammt aus storage.json im Chromium-Code.