FileSystemFileHandle.getFile()
Draft
This page is not complete.
Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getFile()
method of the
FileSystemFileHandle
interface returns 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
var File = FileSystemFileHandle.getFile();
Parameters
None.
Return value
A File object
.
Exceptions
- NotAllowedError
- Thrown if the
PermissionStatus.state
is notgranted
in read mode.
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
[fileHandle] = await window.showOpenFilePicker(pickerOpts);
// get file contents
const fileData = await fileHandle.getFile();
}
Specifications
Specification | Status | Comment |
---|---|---|
File System Access API The definition of 'getFile' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
BCD tables only load in the browser