DirectoryEntrySync

Basic concepts

If you want to create subdirectories, you have to create each child directory in sequence. If you try to create a directory using a full path that includes parent directories that do not exist yet, you get an error. So create the hierarchy by recursively adding a new path after creating the parent directory.

Example

The getFile() method returns a FileEntrySync, which represents a file in the file system. The following creates an empty file called logs.txt in the root directory.

const fileEntry = fs.root.getFile("logs.txt", { create: true });

The getDirectory() method returns a DirectoryEntrySync, which represents a file in the file system. The following creates a new directory called project_dir in the root directory.

const dirEntry = fs.root.getDirectory("project_dir", { create: true });

Method overview

• createReader()
• getFile()
• getDirectory()
• removeRecursively()

Instance methods

createReader()

Creates a new DirectoryReaderSync to read entries from this directory.

Syntax

createReader()

Parameters

None.

Return value

A DirectoryReaderSync object represents a directory in a file system.

Exceptions

This method can raise a DOMException with the following codes:

getFile()

Depending on how you've set the options parameter, the method either creates a file or looks up an existing file.

Syntax

getFile(path)
getFile(path, options)

Parameters

path

Either an absolute path or a relative path from the directory to the file to be looked up or created. You cannot create a file whose immediate parent does not exist. Create the parent directory first.

options

(optional) An object literal describing the behavior of the method. If the file does not exist, it is created.

Return value

A FileEntrySync object representing a file in a file system.

Exceptions

This method can raise a DOMException with the following codes:

getDirectory()

Creates or looks up a directory. The method is similar to getFile() with DirectoryEntrySync being passed.

Syntax

getDirectory(path)
getDirectory(path, options)

Parameters

path

Either an absolute path or a relative path from the directory to the file to be looked up or created. You cannot create a file whose immediate parent does not exist. Create the parent directory first.

options

(optional) An object literal describing the behavior of the method if the file does not exist.

Return value

A DirectoryEntrySync object representing a directory in a file system.

Exceptions

This method can raise a DOMException with the following codes:

removeRecursively()

Deletes a directory and all of its contents. You cannot delete the root directory of a file system.

If you delete a directory that contains a file that cannot be removed or if an error occurs while the deletion is in progress, some of the contents might not be deleted. Catch these cases with error callbacks and retry the deletion.

Syntax

removeRecursively()

Parameters

None.

Return value

Exceptions

This method can raise a DOMException with the following codes:

Specifications

This feature is not part of any current specification. It is no longer on track to become a standard. Use the File and Directory Entries API instead.

Browser compatibility

See also

• File and Directory Entries API