JavaScript метод Storage.key()
Определение и применение
JavaScript метод key() объекта
Storage
при передаче целого числа index возвращает имя ключа с этим индексом в хранилище (объекте
Storage). Если индекс выходит за пределы хранилища, возвращается null. Порядок ключей
определяется производителем браузера, по этой причине на него не следует полагаться.
Поддержка браузерами
Спецификация: multipage
Поддерживается во всех основных браузерах с 2015 года.
| Возможность | Компьютеры | Мобильные | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
key | 4 | 12 | 3.5 | 10.5 | 4 | 18 | 6 | 11 | 3.2 | 1.0 | 4.4 | 3.2 |
поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31
JavaScript синтаксис
const keyName = localStorage.key(index);
const sessionKeyName = sessionStorage.key(index);
Спецификация
Значения параметров
| Параметр | Описание |
|---|---|
index |
Целое число, представляющее номер ключа, имя которого вы хотите получить. Первое имя ключа представлено индексом 0. Обязательный параметр. |
Пример использования
Ключи sessionStorage
Сохраните полный HTML-документ и откройте его через локальный HTTP-сервер: пример использует настоящее хранилище браузера. Встроенное превью изолировано от хранилища сайта, поэтому здесь доступен просмотр кода.
Исходный код для изучения. Запуск на этой странице недоступен.
index.html
<button>Show keys</button><span id="info"></span>
main.js
function showKeys() {
let info = document.getElementById('info')
for (let i = 0; i < 5; i++) {
let key = 'demo_key_' + i
let val = i
try {
sessionStorage.setItem(key, val)
} catch (error) {
info.innerHTML = 'Произошла ошибка ' + error.message
}
}
for (let i = 0; i < sessionStorage.length; i++) {
let currentKeyValue = sessionStorage.key(i)
info.innerHTML += '<p>Ключ под индексом ' + i + ' равен <b>' + currentKeyValue + '</b></p>'
}
}
document.querySelector('button').addEventListener('click', function () {
showKeys()
})
В этом примере с использованием метода
addEventListener()
при нажатии на кнопку (HTML элемент
<button>) вызываем функцию, которая:
-
Инициализирует переменную, которая содержит ссылку на элемент с определенным глобальным атрибутом
id. -
С использованием цикла и метода
setItem()добавляем пять ключей и значений в хранилище сессии (sessionStorage). Обратите внимание, что мы используем конструкциюtry...catch, если по каким-то причинам произойдет ошибка, то мы её перехватим, а информацию о ней добавим в качестве нового текстового содержимого элемента<span>. -
После этого с помощью цикла и свойства
lengthобъектаStorageмы проходим по всем элементам хранилища сессии и с помощью методаkey()выводим все их имена путем добавления содержимого элементу<span>на каждой итерации цикла.
Результат нашего примера:
key() и setItem() объекта Storage