SharedStorage: delete() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

实验性: 这是一项实验性技术
在生产中使用此技术之前,请仔细检查浏览器兼容性表格

SharedStorage 接口的 delete() 方法会从当前源的共享存储中删除现有的键值对。

语法

js
delete(key)

参数

key

一个字符串,代表您要删除的键值对的键。

返回值

一个 Promise,它将以 undefined 解析。

异常

  • 如果出现以下情况,Promise 会以 TypeError 拒绝:
    • 由于共享存储不可用(例如,它被浏览器设置禁用),数据库未能成功清空。
    • key 超出了浏览器定义的长度限制。
    • 调用站点未在成功的 隐私沙盒注册流程中包含共享存储 API。
  • WorkletSharedStorage 的情况下,如果满足以下任一条件,Promise 将会以 TypeError 拒绝:

注意: 如果键值对在共享存储中不存在,则不会抛出错误 — 操作仍然会以 undefined 成功完成。

注意:WindowSharedStorage 的情况下,如果 delete() 操作因共享存储不可用以外的原因未能成功写入数据库,则不会抛出错误 — 操作仍然会以 undefined 成功完成。

示例

js
window.sharedStorage
  .delete("ab-testing-group")
  .then(() => console.log("Value deleted"));

规范

规范
共享存储 API
# dom-sharedstorage-delete

浏览器兼容性

另见