FileSystemDirectoryHandle.getFileHandle()
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getFileHandle() method of the
FileSystemDirectoryHandle interface returns a
FileSystemFileHandle for a file with the specified name, within the
directory the method is called.
Syntax
var FileSystemFileHandle = FileSystemDirectoryHandle.getFileHandle(name);
Parameters
- name
-
A
USVStringrepresenting theFileSystemHandle.nameof the file you wish to retrieve. - options Optional
-
An object with the following properties:
-
create: ABoolean. Defaultfalse. When set totrueif the file is not found, one with the specified name will be created and returned.
-
Return value
A Promise which resolves with a FileSystemFileHandle.
Exceptions
NotAllowedErrorDOMException-
Thrown if
PermissionStatusis not 'granted'. TypeErrorDOMException-
Thrown if the name specified is not a valid string or contains characters that would interfere with the native file system
TypeMismatchErrorDOMException-
Thrown if the named entry is a directory and not a file.
NotFoundErrorDOMException-
Thrown if file doesn't exist and the
createoption is set tofalse.
Examples
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
| Specification |
|---|
| File System Access # api-filesystemdirectoryhandle-getfilehandle |
Browser compatibility
BCD tables only load in the browser