W3cubDocs

/Web APIs

Document: hasStorageAccess() method

The hasStorageAccess() method of the Document interface returns a Promise that resolves with a boolean value indicating whether the document has access to unpartitioned cookies.

This method is part of the Storage Access API.

Syntax

hasStorageAccess()

Parameters

None.

Return value

A Promise that resolves with a boolean value indicating whether the document has access to unpartitioned cookies — true if it does, and false if not.

The result returned by this method can be inaccurate in a couple of circumstances:

The user may have browser settings active that block unpartitioned cookies entirely — in this case true may be returned even though unpartitioned cookies are still inaccessible. To handle such a situation, you should gracefully handle any errors resulting in cookie values being unretrievable; for example, inform the user that access to their personalized settings is blocked and invite them to sign in again to use them.
The browser might not block third-party cookie access by default — in this case false may be returned even though unpartitioned cookies are accessible, and storage access wouldn't need to be requested (i.e. via Document.requestStorageAccess()). To get around this issue, you could query Document.cookie to find out whether your cookies are accessible, and call Document.requestStorageAccess() if they are not.

Note: If the promise gets resolved and a user gesture event was being processed when the function was originally called, the resolve handler will run as if a user gesture was being processed, so it will be able to call APIs that require user activation.

Exceptions

InvalidStateError DOMException: Thrown if the current Document is not yet active.

Examples

document.hasStorageAccess().then((hasAccess) => {
  if (hasAccess) {
    // storage access has been granted already.
  } else {
    // storage access hasn't been granted already;
    // you may want to call requestStorageAccess().
  }
});

Note: See Using the Storage Access API for a more complete example.

Specifications

Specification
The Storage Access API # dom-document-hasstorageaccess

Browser compatibility

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	WebView Android	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet
`hasStorageAccess`	113 Only available to Google Chrome's first-party sets. 78	85	65	No	99 Only available to Opera's first-party sets. 65	11.1	113 Only available to Google Chrome's first-party sets.	113 Only available to Google Chrome's first-party sets. 78	65	No	11.3	No