opendir

function opendir

Jump to heading#opendir(path: PathLike,
cb: (err: ErrnoException | null,
dir: Dir,
) => void,
): void

Asynchronously open a directory. See the POSIX opendir(3) documentation for more details.

Creates an fs.Dir, which contains all further functions for reading from and cleaning up the directory.

The encoding option sets the encoding for the path while opening the directory and subsequent read operations.

Parameters Jump to heading

Jump to heading#path: PathLike

Jump to heading#cb: (err: ErrnoException | null,
dir: Dir,
) => void

void

Jump to heading#opendir(path: PathLike,
options: OpenDirOptions,
cb: (err: ErrnoException | null,
dir: Dir,
) => void,
): void

Jump to heading#path: PathLike

Jump to heading#options: OpenDirOptions

Jump to heading#cb: (err: ErrnoException | null,
dir: Dir,
) => void

void