Skip to main content

read

method Dir.prototype.read
Jump to headingDir.prototype.read(): Promise<Dirent | null>

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.

Return Type Jump to heading

Promise<Dirent | null>

containing {fs.Dirent|null}

Jump to headingDir.prototype.read(cb: (
err: ErrnoException | null,
dirEnt: Dirent | null,
) => void
): void

Parameters Jump to heading

Jump to headingcb: (
err: ErrnoException | null,
dirEnt: Dirent | null,
) => void

Return Type Jump to heading

void
Back to top