Storage: removeItem() method

{{APIRef("Web Storage API")}}

The removeItem() method of the {{domxref("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 ({{jsxref("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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

Using the Web Storage API