Baseline 2023
Newly available
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 getFileHandle()
method of the FileSystemDirectoryHandle
interface returns a FileSystemFileHandle
for a file with the specified name, within the directory the method is called.
getFileHandle(name)
getFileHandle(name, options)
Parameters
name
A string representing the FileSystemHandle.name
of the file you wish to retrieve.
options
Optional
An object with the following properties:
create
Optional
A Boolean
. Default false
. When set to true
if the file is not found, one with the specified name will be created and returned.
A Promise
which resolves with a FileSystemFileHandle
.
NotAllowedError
DOMException
Thrown if the PermissionStatus.state
for the handle is not 'granted'
in readwrite
mode if the create
option is set to true
or in read
mode if the create
option is set to false
.
TypeError
Thrown if the name specified is not a valid string or contains characters that would interfere with the native file system.
TypeMismatchError
DOMException
Thrown if the named entry is a directory and not a file.
NotFoundError
DOMException
Thrown if the current entry is not found or if the file doesn't exist and the create
option is set to false
.
The following example returns a file handle with the specified name, if the file does not exist it is created.
const fileName = "fileToGetName";
// assuming we have a directory handle: 'currentDirHandle'
const fileHandle = currentDirHandle.getFileHandle(fileName, { create: true });
Specifications Browser compatibility See also
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4