StorageManager: persist() method

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The persist() method of the StorageManager interface requests permission to use persistent storage, and returns a Promise that resolves to true if permission is granted and bucket mode is persistent, and false otherwise.

Note: This method is not available in Web Workers, though the StorageManager interface is.

Syntax

js
persist()

Parameters

None.

Return value

A Promise that resolves to a Boolean.

Exceptions

TypeError

Thrown if obtaining a local storage shelf failed. For example, if the current origin is an opaque origin or if the user has disabled storage.

Example

js
if (navigator.storage && navigator.storage.persist) {
  navigator.storage.persist().then((persistent) => {
    if (persistent) {
      console.log("Storage will not be cleared except by explicit user action");
    } else {
      console.log("Storage may be cleared by the UA under storage pressure.");
    }
  });
}

Specifications

Specification
Storage Standard
# ref-for-dom-storagemanager-persist

Browser compatibility

BCD tables only load in the browser