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