W3cubDocs

/Web APIs

FileSystemDirectoryHandle: getDirectoryHandle() method

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

js

getDirectoryHandle(name)
getDirectoryHandle(name, options)

Parameters

name

A string representing the FileSystemHandle.name of the subdirectory you wish to retrieve.

options Optional

An optional object containing options for the retrieved subdirectory. Options are as follows:

create

A boolean value, which defaults to false. When set to true 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 DOMException

Thrown if PermissionStatus is not 'granted'.

TypeError

Thrown if the name specified is not a valid string or contains characters that would interfere with the native file system.

TypeMismatchError DOMException

Thrown if the returned entry is a file and not a directory.

NotFoundError DOMException

Thrown if directory doesn't exist and the create option is set to false.

Examples

The following example returns a directory handle with the specified name, if the directory does not exist it is created.

js

const dirName = "directoryToGetName";

// assuming we have a directory handle: 'currentDirHandle'
const subDir = currentDirHandle.getDirectoryHandle(dirName, { create: true });

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getDirectoryHandle 86 86 111 No 72 15.2 No 86 111 61 15.2 14.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/FileSystemDirectoryHandle/getDirectoryHandle