Add-ons

StorageArea.set()

Stores one or more items in the storage area, or update existing items.

When you store or update a value using this API, the storage.onChanged event will fire.

This is an asynchronous function that returns a Promise.

Syntax

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

<storageType> will be one of the writable storage types — storage.sync or storage.local.

Parameters

keys

An object containing one or more key/value pairs to be stored in storage. If an item already exists, its value will be updated.

Values may be primitive types (such as numbers, booleans, and strings) or Array types.

It's generally not possible to store other types, such as Function, Date, RegExp, Set, Map, ArrayBuffer and so on. Some of these unsupported types will restore as an empty object, and some cause set() to throw an error. The exact behavior here is browser-specific.

Return value

A Promise that will be fulfilled with no arguments if the operation succeeded. If the operation failed, the promise will be rejected with an error message.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes Yes1454833

1. storage is limited to 1MB per value.

Examples

function onError(error) {
  console.log(`Error: ${error}`);
}

// Define two objects to store

// Note that the function will not be stored on any implementation
// and attempting to store it will throw an error in Firefox
let monster = {
  name: "Kraken",
  speak: function() {console.log("ROARR!!!")},
  birthday: new Date(2012, 11, 17)
}

// Without a function
let kitten = {
  name: "Moggy",
  birthday: new Date(2006, 7, 12)
}

// store the objects

// Works for all browsers
let setting = browser.storage.local.set({kitten});

// just check for errors
setting.then(null, onError);

// On Firefox:
//   "Error: DataCloneError: The object could not be cloned."
// Other implementations: both objects stored, but `speak === {}`
// for monster when retrieved.
setting = browser.storage.local.set({kitten, monster});

setting.then(null, onError);

Acknowledgements

This API is based on Chromium's chrome.storage API. This documentation is derived from storage.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, Kwan, cmcaine, jonathanKingston, Makyen, chrisdavidmills
 Last updated by: wbamberg,