SharedStorage: delete() method
Shared Storage API
Shared Storage API
The delete() method of the SharedStorage interface deletes an existing key-value pair from the current origin's shared storage.
Syntax
delete(key)
Parameters
key- : A string representing the key of the key-value pair you want to delete.
Return value
A Promise that fulfills with undefined.
Exceptions
- The
Promiserejects with a TypeError if: - The database was not cleared successfully due to shared storage not being available (for example it is disabled using a browser setting).
keyexceeds the browser-defined maximum length.- The calling site does not have the Shared Storage API included in a successful privacy sandbox enrollment process.
- In the case of WorkletSharedStorage, the
Promiserejects with a TypeError if: - The worklet module has not been added with SharedStorageWorklet.addModule().
[!NOTE] If the key-value pair doesn't exist in the shared storage, no error is thrown — the operation still fulfills with
undefined.[!NOTE] In the case of WindowSharedStorage, if the
delete()operation doesn't successfully write to the database for a reason other than shared storage not being available, no error is thrown — the operation still fulfills withundefined.
Examples
window.sharedStorage
.delete("ab-testing-group")
.then(() => console.log("Value deleted"));