Storage.removeItem()

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

SyntaxEdit

storage.removeItem(keyName);

Parameters

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

Returns

No return value.

ExampleEdit

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

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.

SpecificationsEdit

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

Browser compatibilityEdit

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
localStorage 4 3.5 8 10.50 4
sessionStorage 5 2 8 10.50 4

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 alsoEdit

Using the Web Storage API

Document Tags and Contributors

 Contributors to this page: teoli, scunliffe, chrisdavidmills
 Last updated by: teoli,