Dirent

external class Dirent(source)

A representation of a directory entry, which can be a file or a subdirectory within the directory, as returned by reading from an fs.Dir. The directory entry is a combination of the file name and file type pairs.

Additionally, when {@link readdir} or {@link readdirSync} is called with the withFileTypes option set to true, the resulting array is filled with fs.Dirent objects, rather than strings or Buffer s.

Since

v10.10.0

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

The file name that this fs.Dirent object refers to. The type of this value is determined by the options.encoding passed to {@link readdir} or {@link readdirSync}.

Link copied to clipboard

The base path that this fs.Dirent object refers to.

Link copied to clipboard

Alias for dirent.parentPath.

Functions

Link copied to clipboard

Returns true if the fs.Dirent object describes a block device.

Link copied to clipboard

Returns true if the fs.Dirent object describes a character device.

Link copied to clipboard

Returns true if the fs.Dirent object describes a file system directory.

Link copied to clipboard

Returns true if the fs.Dirent object describes a first-in-first-out (FIFO) pipe.

Link copied to clipboard

Returns true if the fs.Dirent object describes a regular file.

Link copied to clipboard

Returns true if the fs.Dirent object describes a socket.

Link copied to clipboard

Returns true if the fs.Dirent object describes a symbolic link.