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 | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'Storage.removeItem' in that specification. |
Living Standard |
Browser compatibility
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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
removeItem | Chrome Full support 4 | Edge Full support 12 | Firefox Full support 3.5 | IE Full support 8 | Opera Full support 10.5 | Safari Full support 4 | WebView Android Full support ≤37 | Chrome Android Full support 18 | Firefox Android Full support 6 | Opera Android Full support 11 | Safari iOS Full support 3.2 | Samsung Internet Android Full support 1.0 |
Legend
- Full support
- Full support