SharedStorage: delete() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

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 Promise rejects 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).
- key exceeds 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 Promise rejects 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 with undefined.

Examples

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