Class Dirent

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 readdir or 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

Hierarchy

  • Dirent

Constructors

constructor

Properties

name parentPath path

Methods

isBlockDevice isCharacterDevice isDirectory isFIFO isFile isSocket isSymbolicLink

Constructors

constructor

Properties

name

name: string

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

Since

v10.10.0

parentPath

parentPath: string

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

Since

v18.20.0

path

path: string

Alias for dirent.parentPath.

Since

v18.17.0

Deprecated

Since v18.20.0

Methods

isBlockDevice

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

    Returns boolean

    Since

    v10.10.0

isCharacterDevice

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

    Returns boolean

    Since

    v10.10.0

isDirectory

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

    Returns boolean

    Since

    v10.10.0

isFIFO

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

    Returns boolean

    Since

    v10.10.0

isFile

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

    Returns boolean

    Since

    v10.10.0

isSocket

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

    Returns boolean

    Since

    v10.10.0

isSymbolicLink

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

    Returns boolean

    Since

    v10.10.0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc