Storage: removeItem() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
The removeItem() method of the Storage
interface, when passed a key name, will remove that key from the given
Storage object if it exists.
The Storage interface of the Web Storage API provides access to a
particular domain's session or local storage.
If there is no item associated with the given key, this method will do nothing.
Syntax
removeItem(keyName)
Parameters
keyName-
A string containing the name of the key you want to remove.
Return value
None (undefined).
Examples
The following function creates three data items inside local storage, then removes the
image data item.
function populateStorage() {
localStorage.setItem("bgcolor", "red");
localStorage.setItem("font", "Helvetica");
localStorage.setItem("image", "myCat.png");
localStorage.removeItem("image");
}
We can do the same for the session storage.
function populateStorage() {
sessionStorage.setItem("bgcolor", "red");
sessionStorage.setItem("font", "Helvetica");
sessionStorage.setItem("image", "myCat.png");
sessionStorage.removeItem("image");
}
Note: To see this used within a real-world example, see our Web Storage Demo.
Specifications
| Specification |
|---|
| HTML # dom-storage-removeitem-dev |
Browser compatibility
| desktop | mobile | server | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
removeItem
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support