Class Dir

constructor

• new Dir(path): Dir

• Parameters

  • path: string

  Returns Dir

Readonly path

[asyncIterator]

• [asyncIterator](): AsyncIterableIterator<Dirent>

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

  Returns AsyncIterableIterator<Dirent>

close

• close(): Promise<void>

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

  Returns Promise<void>
• close(cb): void

• Parameters

  • cb: Callback

  Returns void

closeSync

• closeSync(): void

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

  Returns void

next

• next(): Promise<IteratorResult<Dirent, any>>

• Returns Promise<IteratorResult<Dirent, any>>

read

• read(): Promise<null | Dirent>

• Asynchronously read the next directory entry via readdir(3) as an Dirent. After the read is completed, a value is returned that will be resolved with an 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.

  Returns Promise<null | Dirent>
• read(cb): void

• Parameters

  • cb: Callback<[null | Dirent]>

  Returns void

readSync

• readSync(): null | Dirent

• Synchronously read the next directory entry via readdir(3) as a Dirent. 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.

  Returns null | Dirent