Skip to main content
Dirent - node__fs.d.ts - Node documentation
class Dirent

Usage in Deno

```typescript import { Dirent } from "node:node__fs.d.ts"; ```
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](../.././node__fs.d.ts/~/readdir) or [readdirSync](../.././node__fs.d.ts/~/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

name: string
The file name that this `fs.Dirent` object refers to. The type of this value is determined by the `options.encoding` passed to [readdir](../.././node__fs.d.ts/~/readdir) or [readdirSync](../.././node__fs.d.ts/~/readdirSync).
parentPath: string
The base path that this `fs.Dirent` object refers to.
deprecated
path: string
Alias for `dirent.parentPath`.

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.
isFIFO(): boolean
Returns `true` if the `fs.Dirent` object describes a first-in-first-out (FIFO) pipe.
isFile(): boolean
Returns `true` if the `fs.Dirent` object describes a regular file.
isSocket(): boolean
Returns `true` if the `fs.Dirent` object describes a socket.