FileSystemHandle: requestPermission() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Note: This feature is available in Web Workers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The requestPermission() method of the FileSystemHandle interface requests read or readwrite permissions for the file handle.

Syntax

js
requestPermission(descriptor)

Parameters

descriptor Optional

An object which specifies the permission mode to query for. Options are as follows:

'mode' Optional

Can be either 'read' or 'readwrite'.

Return value

A Promise that resolves with PermissionStatus.state which is one of 'granted', 'denied' or 'prompt'. It may also reject with one of the exceptions below.

Exceptions

TypeError

Thrown if no parameter is specified or the mode is not that of 'read' or 'readwrite'

SecurityError DOMException

Thrown in one of the following cases:

  • The method was called in a context that's not same-origin as the top-level context (i.e. a cross-origin iframe).
  • There was no transient user activation such as a button press. This includes when the handle is in a non-Window context which cannot consume user activation, such as a worker.

Security

Transient user activation is required. The user has to interact with the page or a UI element in order for this feature to work.

Examples

The following asynchronous function requests permissions if they have not been granted.

js
// fileHandle is a FileSystemFileHandle
// withWrite is a boolean set to true if write

async function verifyPermission(fileHandle, withWrite) {
  const opts = {};
  if (withWrite) {
    opts.mode = "readwrite";
  }

  // Check if we already have permission, if so, return true.
  if ((await fileHandle.queryPermission(opts)) === "granted") {
    return true;
  }

  // Request permission to the file, if the user grants permission, return true.
  if ((await fileHandle.requestPermission(opts)) === "granted") {
    return true;
  }

  // The user did not grant permission, return false.
  return false;
}

Specifications

Specification
File System Access
# api-filesystemhandle-requestpermission

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
requestPermission
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.

See also