StorageArea.clear()
Removes all items from the storage area.
This is an asynchronous function that returns a Promise
.
Syntax
js
let clearing = browser.storage.<storageType>.clear()
Where <storageType>
is one of the writable storage types — storage.local
, storage.session
, or storage.sync
Parameters
None.
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
Report problems with this compatibility data on GitHubdesktop | mobile | ||||||
---|---|---|---|---|---|---|---|
clear |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- See implementation notes.
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
js
function onCleared() {
console.log("OK");
}
function onError(e) {
console.log(e);
}
let clearStorage = browser.storage.local.clear();
clearStorage.then(onCleared, onError);
Note:
This API is based on Chromium's chrome.storage
API. This documentation is derived from storage.json
in the Chromium code.