Storage.getItem()

The getItem() method of the Storage interface, when passed a key name, will return that key's value, or null if the key does not exist, in the given Storage object.

Syntax

var aValue = storage.getItem(keyName);

Parameters

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

Return value

A DOMString containing the value of the key. If the key does not exist, null is returned.

Example

The following function retrieves three data items from local storage, then uses them to set custom styles on a page.

function setStyles() {
  var currentColor = localStorage.getItem('bgcolor');
  var currentFont = localStorage.getItem('font');
  var currentImage = localStorage.getItem('image');

  document.getElementById('bgcolor').value = currentColor;
  document.getElementById('font').value = currentFont;
  document.getElementById('image').value = currentImage;

  htmlElem.style.backgroundColor = '#' + currentColor;
  pElem.style.fontFamily = currentFont;
  imgElem.setAttribute('src', currentImage);
}

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.getItem' in that specification.
Living Standard

Browser compatibility

BCD tables only load in the browser

See also