Class Dir

A class representing a directory stream.

Created by opendir, opendirSync, or fsPromises.opendir().

import { opendir } from 'fs/promises';

try {
  const dir = await opendir('./');
  for await (const dirent of dir)
    console.log(dirent.name);
} catch (err) {
  console.error(err);
}

When using the async iterator, the fs.Dir object will be automatically closed after the iterator exits.

Since

v12.12.0

Hierarchy

  • Dir

Implements

Constructors

constructor

Properties

path

Methods

[asyncIterator] close closeSync read readSync

Constructors

constructor

Properties

Readonly path

path: string

The read-only path of this directory as was provided to opendir,opendirSync, or fsPromises.opendir().

Since

v12.12.0

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<Dirent>

  • Asynchronously iterates over the directory via readdir(3) until all entries have been read.

    Returns AsyncIterableIterator<Dirent>

close

  • Asynchronously close the directory's underlying resource handle. Subsequent reads will result in errors.

    A promise is returned that will be resolved after the resource has been closed.

    Since

    v12.12.0

    Returns Promise<void>

  • Parameters

    Returns void

closeSync

  • Synchronously close the directory's underlying resource handle. Subsequent reads will result in errors.

    Since

    v12.12.0

    Returns void

read

  • Asynchronously read the next directory entry via readdir(3) as an fs.Dirent.

    A promise is returned that will be resolved with an fs.Dirent, or nullif there are no more directory entries to read.

    Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. Entries added or removed while iterating over the directory might not be included in the iteration results.

    Since

    v12.12.0

    Returns

    containing {fs.Dirent|null}

    Returns Promise<Dirent>

  • Parameters

    • cb: ((err: ErrnoException, dirEnt: Dirent) => void)
        • (err: ErrnoException, dirEnt: Dirent): void

        • Parameters

          • err: ErrnoException
          • dirEnt: Dirent

          Returns void

    Returns void

readSync

  • Synchronously read the next directory entry as an fs.Dirent. See the POSIX readdir(3) documentation for more detail.

    If there are no more directory entries to read, null will be returned.

    Directory entries returned by this function are in no particular order as provided by the operating system's underlying directory mechanisms. Entries added or removed while iterating over the directory might not be included in the iteration results.

    Since

    v12.12.0

    Returns Dirent

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc