Storage.setItem()

The setItem() method of the Storage interface, when passed a key name and value, will add that key to the given Storage object, or update that key's value if it already exists.

Syntax

setItem(keyName, keyValue)

Parameters

keyName

A string containing the name of the key you want to create/update.

keyValue

A string containing the value you want to give the key you are creating/updating.

Return value

None (undefined).

Exceptions

setItem() may throw an exception if the storage is full. Developers should make sure to always catch possible exceptions from setItem().

Examples

The following function creates three data items inside local storage.

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

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

Specifications

Specification
HTML Standard
# dom-storage-setitem-dev

Browser compatibility

BCD tables only load in the browser

See also