共享存储：delete() 方法

实验性： 这是 实验性技术
在生产环境中使用之前，请仔细查看 浏览器兼容性表。

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

语法

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

浏览器兼容性

BCD 表只在启用了 JavaScript 的浏览器中加载。

另请参阅