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(key);

Parameters

key

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

Returns

A DOMString containing the name of the key.

Example

The following function iterates over the local storage keys:

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

Specifications

Browser compatibility

All browsers have varying capacity levels for both localStorage and sessionStorage. Here is a detailed rundown of all the storage capacities for various browsers.

See also

Using the Web Storage API