FileSystemDirectoryHandle.getDirectoryHandle()
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The getDirectoryHandle() method of the
FileSystemDirectoryHandle interface returns a
FileSystemDirectoryHandle for a subdirectory with the specified name
within the directory handle on which the method is called.
Syntax
var FileSystemDirectoryHandle = FileSystemDirectoryHandle.getDirectoryHandle();
Parameters
- name
-
A
USVStringrepresenting theFileSystemHandle.nameof the subdirectory you wish to retrieve. - options Optional
-
An optional object containing options for the retrieved subdirectory. Options are as follows:
-
create: ABoolean. Defaultfalse. When set totrueif the directory is not found, one with the specified name will be created and returned.
-
Return value
A Promise which resolves with a FileSystemDirectoryHandle.
Exceptions
NotAllowedErrorDOMException-
Thrown if
PermissionStatusis not 'granted'. TypeMismatchErrorDOMException-
Thrown if the returned entry is a file and not a directory.
NotFoundErrorDOMException-
Thrown if directory doesn't exist and the
createoption is set tofalse.
Examples
The following example returns a directory handle with the specified name, if the directory does not exist it is created.
const dirName = 'directoryToGetName';
// assuming we have a directory handle: 'currentDirHandle'
const subDir = currentDirHandle.getDirectoryHandle(dirName, {create: true});
Specifications
| Specification |
|---|
| File System Access # api-filesystemdirectoryhandle-getdirectoryhandle |
Browser compatibility
BCD tables only load in the browser