W3cubDocs

/Web APIs

FileSystemFileHandle: getFile() method

Baseline 2023

Newly available

Since ⁨March 2023⁩, this feature works across the latest devices and browser versions. This feature might not work in older devices or 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.

The getFile() method of the FileSystemFileHandle interface returns a Promise which resolves to a File object representing the state on disk of the entry represented by the handle.

If the file on disk changes or is removed after this method is called, the returned File object will likely be no longer readable.

Syntax

getFile()

Parameters

None.

Return value

A Promise which resolves to a File object.

Exceptions

NotAllowedError DOMException: Thrown if the PermissionStatus.state is not granted in read mode.
NotFoundError DOMException: Thrown if current entry is not found.

Examples

The following asynchronous function presents a file picker and once a file is chosen, uses the getFile() method to retrieve the contents.

async function getTheFile() {
  // open file picker
  const [fileHandle] = await window.showOpenFilePicker(pickerOpts);

  // get file contents
  const fileData = await fileHandle.getFile();
}

Specifications

Specification
File System> # api-filesystemfilehandle-getfile>

Browser compatibility

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`getFile`	86	86	111	72	15.2	109	111	74	15.2	21.0	109	15.2