Class Dirent<Name>

constructor

• new Dirent<Name extends string | Buffer<ArrayBufferLike> = string>(): fs.Dirent<
      Name,
  >

  Type Parameters

  • Name extends string | Buffer<ArrayBufferLike> = string

  Returns fs.Dirent<Name>

ino

type

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 path to the parent directory of the file this fs.Dirent object refers to.

  Returns string

  Since

  v20.12.0, v18.20.0

path

• get path(): string

  Returns string

  Deprecated

  Removed in Node v24, use parentPath instead.

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

Staticfrom

• from(
      vfs: vfs.Dirent,
      encoding?: "buffer" | BufferEncoding | null,
      parentPath?: string,
  ): fs.Dirent<string>
  Internal

  vfs.path is relative to the directory that was read, so parentPath is resolved against it— like Node does.

  Parameters

  • vfs: vfs.Dirent
  • Optionalencoding: "buffer" | BufferEncoding | null
  • parentPath: string = '.'

  Returns fs.Dirent<string>