@haxall/haxall
    Preparing search index...

    Class Dirent<Name>

    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.

    v10.10.0

    Type Parameters

    • Name extends string | Buffer = string
    Index

    Constructors

    constructor

    Properties

    name parentPath path

    Methods

    isBlockDevice isCharacterDevice isDirectory isFIFO isFile isSocket isSymbolicLink

    Constructors

    • Type Parameters

      • Name extends string | Buffer<ArrayBufferLike> = string

      Returns Dirent<Name>

    Properties

    name: Name

    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.

    v10.10.0

    parentPath: string

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

    v20.12.0

    path: string

    Alias for dirent.parentPath.

    v20.1.0

    Since v20.12.0

    Methods

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

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods