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

v0.0.67

Hierarchy

  • Dirent

Constructors

constructor

Properties

name

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

v0.0.67

Methods

isBlockDevice

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

    Since

    v0.0.67

    Returns boolean

isCharacterDevice

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

    Since

    v0.0.67

    Returns boolean

isDirectory

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

    Since

    v0.0.67

    Returns boolean

isFIFO

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

    Since

    v0.0.67

    Returns boolean

isFile

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

    Since

    v0.0.67

    Returns boolean

isSocket

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

    Since

    v0.0.67

    Returns boolean

isSymbolicLink

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

    Since

    v0.0.67

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc