W3cubDocs

/DOM

Storage.key

The key() method of the Storage interface, when passed a number n, returns the name of the nth key in the storage. The order of keys is user-agent defined, so you should not rely on it.

Syntax

var aKeyName = storage.key(index);

Parameters

index
An integer representing the number of the key you want to get the name of. This is a zero-based index.

Return value

A DOMString containing the name of the key.

Examples

The following function iterates over the local storage keys:

function forEachKey(callback) {
  for (var i = 0; i < localStorage.length; i++) {
    callback(localStorage.key(i));
  }
}

The following function iterates over the local storage keys and gets the value set for each key:

for(var i =0; i < localStorage.length; i++){
   console.log(localStorage.getItem(localStorage.key(i)));
}

Note: For a real world example, see our Web Storage Demo.

Specifications

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 4 12 3.5 8 10.5 4
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support Yes 18 13 6 11 3.2 ?

See also

Using the Web Storage API

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Storage/key