@haxall/haxall
    Preparing search index...

    Class Dir

    A class representing a directory stream.

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

    import { opendir } from 'node: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.

    v12.12.0

    Implements

    Index

    Constructors

    constructor

    Properties

    path

    Methods

    [asyncIterator] close closeSync read readSync

    Constructors

    Properties

    path: string

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

    v12.12.0

    Methods

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

      Returns AsyncIterator<Dirent<string>>

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

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

      Returns Promise<void>

      v12.12.0

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

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

      Parameters

      Returns void

      v12.12.0

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

      Returns void

      v12.12.0

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

      A promise is returned that will be fulfilled with an fs.Dirent, or null if 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.

      Returns Promise<Dirent<string>>

      containing {fs.Dirent|null}

      v12.12.0

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

      A promise is returned that will be fulfilled with an fs.Dirent, or null if 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.

      Parameters

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

      Returns void

      containing {fs.Dirent|null}

      v12.12.0

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

      Returns Dirent<string>

      v12.12.0

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods