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

Specification Status Comment
HTML Living Standard
The definition of 'Storage.key' in that specification.
Living Standard  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support4123.5810.54
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support1818136113.2 ?

See also

Using the Web Storage API

Document Tags and Contributors

Last updated by: galcyurio,