StorageArea.remove()

Removes one or more items from the storage area.

This is an asynchronous function that returns a Promise.

Syntax

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

<storageType> is one of the writable storage types — storage.local, storage.session, or storage.sync.

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

BCD tables only load in the browser

Examples

Remove a single item:

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

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

let removeKitten = browser.storage.sync.remove("kitten");
removeKitten.then(onRemoved, onError);

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