StorageArea.remove()

Removes one or more items from the storage area.

This is an asynchronous function that returns a Promise.

Syntax

var removingItem = browser.storage.<storageType>.remove(
  keys             // string, or array of strings
)

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

Parameters

keys
A string, or array of strings, representing the key(s) of the item(s) to be removed.

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

Examples

Remove a single item:

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

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

var removeKitten = browser.storage.remove("kitten");
removeKitten.then(onRemoved, 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,