FileSystemDirectoryHandle.getDirectoryHandle()
Draft
This page is not complete.
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
USVString
representing theFileSystemHandle.name
of 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 totrue
if 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
NotAllowedError
- If
PermissionStatus
is not 'granted'. TypeMismatchError
- If the returned entry is a file and not a directory.
NotFoundError
- if directory doesn't exist and the
create
option 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 | Status | Comment |
---|---|---|
Unknown The definition of 'getDirectoryHandle' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
BCD tables only load in the browser