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

js
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

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

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

Specifications

Specification
Shared Storage API
# dom-sharedstorage-delete

Browser compatibility

See also