Storage: removeItem() 方法

Baseline 已广泛支持

此特性已相当成熟,可在许多设备和浏览器版本上使用。自 ⁨2015 年 7 月⁩以来,各浏览器均已提供此特性。

当向 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");
}

我们也可以对会话存储执行相同的操作。

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

  sessionStorage.removeItem("image");
}

注意: 要查看在实际示例中的应用,请参阅我们的 Web Storage 演示

规范

规范
HTML
# dom-storage-removeitem-dev

浏览器兼容性

另见

使用 Web Storage API