Interface: 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.
Since
v10.10.0
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Name extends string | Buffer | string |
Properties
| Property | Type | Description |
|---|---|---|
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. Since v10.10.0 |
parentPath | string | The path to the parent directory of the file this fs.Dirent object refers to. Since v20.12.0, v18.20.0 |
Methods
isBlockDevice()
isBlockDevice(): boolean;Returns true if the fs.Dirent object describes a block device.
Returns
boolean
Since
v10.10.0
isCharacterDevice()
isCharacterDevice(): boolean;Returns true if the fs.Dirent object describes a character device.
Returns
boolean
Since
v10.10.0
isDirectory()
isDirectory(): boolean;Returns true if the fs.Dirent object describes a file system directory.
Returns
boolean
Since
v10.10.0
isFIFO()
isFIFO(): boolean;Returns true if the fs.Dirent object describes a first-in-first-out (FIFO) pipe.
Returns
boolean
Since
v10.10.0
isFile()
isFile(): boolean;Returns true if the fs.Dirent object describes a regular file.
Returns
boolean
Since
v10.10.0
isSocket()
isSocket(): boolean;Returns true if the fs.Dirent object describes a socket.
Returns
boolean
Since
v10.10.0
isSymbolicLink()
isSymbolicLink(): boolean;Returns true if the fs.Dirent object describes a symbolic link.
Returns
boolean
Since
v10.10.0