Storage.removeItem()

The removeItem() method of the Storage interface, when passed a key name, will remove that key from the storage.

Syntax

JavaScript
storage.removeItem(keyName);

Parameters

keyName
A DOMString containing the name of the key you want to remove.

Returns

No return value.

Example

The following function creates three data items inside local storage, then remove the image data item.

JavaScript
function populateStorage() {
  localStorage.setItem('bgcolor', 'red');
  localStorage.setItem('font', 'Helvetica');
  localStorage.setItem('image', 'myCat.png');

  localStorage.removeItem('image');
}

Note: To see this used within a real world example, see our Web Storage Demo.

Specifications

Specification Status Comment
Web Storage (Second edition)
The definition of 'removeItem()' in that specification.
Recommendation  

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
localStorage 4 3.5 8 10.50 4
sessionStorage 5 2 8 10.50 4
Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support 2.1 ? 8 11 iOS 3.2

All browsers have varying capacity levels for both localStorage and sessionStorage. Here is a detailed rundown of all the storage capacities for various browsers.

Note: since iOS 5.1, Safari Mobile stores localStorage data in the cache folder, which is subject to occasional clean up, at the behest of the OS, typically if space is short.

See also

Using the Web Storage API

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/storage/removeitem

API Method Reference Référence Storage Web Storage