Storage.removeItem()
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
storage.removeItem(keyName);
Parameters
keyName
-
A
DOMString
containing the name of the key you want to remove.
Return value
Example
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 Standard (HTML) # dom-storage-removeitem-dev |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
removeItem |
4 |
12 |
3.5 |
8 |
10.5 |
4 |
≤37 |
18 |
6 |
11 |
3.2 |
1.0 |
See also
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Storage/removeItem