Storage.key()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Метод key() интерфейса Storage получает числовое значение n и возвращает имя n-ого ключа из данного объекта Storage. Порядок ключей зависит от реализации браузера, поэтому лучше не полагаться на него.

Syntax

js
var aKeyName = storage.key(index);

Параметры

index

Целочисленное значение, представляющее номер ключа, имя которого нужно получить. Индексация начинается с нуля.

Возвращаемое значение

DOMString с именем ключа. Если этот индекс не найден, вернётся null.

Примеры

Следующая функция перебирает все ключи из локального хранилища:

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

Следующая функция перебирает все ключи из локального хранилища и получает значение по каждому из них:

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

Примечание: Более реалистичный пример использования функции показан на странице Web Storage Demo.

Спецификации

Specification
HTML Standard
# dom-storage-key-dev

Совместимость с браузерами

BCD tables only load in the browser

Смотрите также