SharedStorage: clear() 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 clear() method of the SharedStorage interface clears the current origin's shared storage, removing all data from it.

Syntax

clear()

Parameters

None.

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).
- 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: In the case of WindowSharedStorage, if the clear() 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.clear().then(() => console.log("Shared storage cleared"));