FileSystemDirectoryHandle.getFileHandle()

Draft

This page is not complete.

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 USVString representing the FileSystemHandle.name of the file you wish to retrieve.
options Optional
  • create: A Boolean. Default false. When set to true if 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

NotAllowedError
If PermissionStatus is not 'granted'.
TypeError
If the name specified is not a valid string or contains characters that would interfere with the native file system
TypeMismatchError
If the named entry is a directory and not a file.
NotFoundError
if file doesn't exist and the create option is set to false.

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 Status Comment
Unknown
The definition of 'getFileHandle' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also