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
)
Where <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.
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);
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
remove
|
|
|
|
|
|
|
|
|
Supports empty key
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- See implementation notes.
Note:
This API is based on Chromium's chrome.storage API. This documentation is derived from storage.json in the Chromium code.