Storage.removeItem()

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.

Storage 接口的 removeItem() 方法,当传递一个键名时,将从给定的 Storage 对象中删除该键(如果它存在)。Web Storage APIStorage 接口提供对特定域的会话或本地存储的访问。

如果没有与该给定键名匹配的项,则此方法将不执行任何操作。

语法

js
removeItem(keyName)

参数

keyName

一个包含你要删除的键名字符串。

返回值

无 (undefined)。

示例

下面的函数在本地存储里面创建三个数据项,然后把 image 数据项移除。

js
function populateStorage() {
  localStorage.setItem("bgcolor", "red");
  localStorage.setItem("font", "Helvetica");
  localStorage.setItem("image", "myCat.png");

  localStorage.removeItem("image");
}

我们可以为 session storage 做同样的事情。

js
function populateStorage() {
  sessionStorage.setItem("bgcolor", "red");
  sessionStorage.setItem("font", "Helvetica");
  sessionStorage.setItem("image", "myCat.png");

  sessionStorage.removeItem("image");
}

备注:有关实际运行的例子,详见 Web Storage 演示

规范

Specification
HTML Standard
# dom-storage-removeitem-dev

浏览器兼容性

BCD tables only load in the browser

相关链接