Class Dirent<Name>

constructor

• new Dirent<Name extends string | Buffer<ArrayBufferLike> = string>(
      path: string,
      stats: InodeLike,
      encoding?: null | "buffer" | BufferEncoding,
  ): Dirent<Name>

  Type Parameters

  • Name extends string | Buffer<ArrayBufferLike> = string

  Parameters

  • path: string
  • stats: InodeLike
  • Optionalencoding: null | "buffer" | BufferEncoding

  Returns Dirent<Name>

path

name

• get 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.

  Returns Name

  Since

  v10.10.0

parentPath

• get parentPath(): string

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

  Returns string

  Since

  v20.12.0

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