StorageArea.remove()

Removes one or more items from the storage area.

This is an asynchronous function that returns a Promise.

Syntax

let 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

Examples

Remove a single item:

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

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

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