method

fs.Dir.read

read(): Promise<null | Dirent<string>>;

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

containing {fs.Dirent|null}

read(

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

): void;

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.

@returns

containing {fs.Dirent|null}