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

瀏覽器相容性

另見