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.
Properties Jump to heading
Jump to headingname: stringThe 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.
Jump to headingparentPath: stringThe base path that this fs.Dirent object refers to.
Jump to headingpath: stringAlias for dirent.parentPath.
Methods Jump to heading
Jump to headingisBlockDevice(): booleanReturns true if the fs.Dirent object describes a block device.
Jump to headingisCharacterDevice(): booleanReturns true if the fs.Dirent object describes a character device.
Jump to headingisDirectory(): booleanReturns true if the fs.Dirent object describes a file system
directory.
Jump to headingisFIFO(): booleanReturns true if the fs.Dirent object describes a first-in-first-out
(FIFO) pipe.
Jump to headingisFile(): booleanReturns true if the fs.Dirent object describes a regular file.
Jump to headingisSocket(): booleanReturns true if the fs.Dirent object describes a socket.
Jump to headingisSymbolicLink(): booleanReturns true if the fs.Dirent object describes a symbolic link.