FileSystemDirectoryHandle: getFileHandle() method
File System API
File System API
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
getFileHandle(name)
getFileHandle(name, options)
Parameters
name- : A string representing the FileSystemHandle.name of the file you wish to retrieve.
options- : An object with the following properties:
create- : A Boolean. Default
false. 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 the PermissionStatus.state for the handle is not
'granted'inreadwritemode if thecreateoption is set totrueor inreadmode if thecreateoption is set tofalse. - TypeError
- : 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 the current entry is not found or if the 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 = await currentDirHandle.getFileHandle(fileName, {
create: true,
});