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 #
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.
#parentPath: string
The base path that this fs.Dirent
object refers to.
Methods #
#isBlockDevice(): boolean
Returns true
if the fs.Dirent
object describes a block device.
#isCharacterDevice(): boolean
Returns true
if the fs.Dirent
object describes a character device.
#isDirectory(): boolean
Returns true
if the fs.Dirent
object describes a file system
directory.
#isSymbolicLink(): boolean
Returns true
if the fs.Dirent
object describes a symbolic link.