SharedStorage: delete() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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 aTypeErrorif:- 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, thePromiserejects with aTypeErrorif:- The worklet module has not been added with
SharedStorageWorklet.addModule().
- The worklet module has not been added with
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 with undefined.
Examples
window.sharedStorage
.delete("ab-testing-group")
.then(console.log("Value deleted"));
Specifications
| Specification |
|---|
| Shared Storage API # dom-sharedstorage-delete |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
delete | ||||||||||||