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

var 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.
  • Primitive values (such as numbers) and arrays will serialize as expected.
  • Functions will be omitted.
  • Dates, and Regexes will serialize using their String representation.

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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Compatibility notes

Edge

  • storage is limited to 1MB per value.

Examples

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

// define 2 objects, that contain:
// a string, a function, a Date
var monster = {
  name: "Kraken",
  speak: function() {console.log("ROARR!!!")},
  birthday: new Date(2012, 11, 17)
}

var kitten = {
  name: "Moggy",
  speak: function() {console.log("Miaow")},
  birthday: new Date(2006, 7, 12)
}

// store the objects
var setting = browser.storage.local.set({kitten, monster});
// just check for errors
setting.then(null, onError);

Example add-ons

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, Makyen, chrisdavidmills
 Last updated by: wbamberg,