opendir - fs - Node documentation

function opendir

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

Deprecated

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

path: PathLike

cb: (err: ErrnoException | null,
dir: Dir,
) => void

void

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

Deprecated

path: PathLike

options: OpenDirOptions

cb: (err: ErrnoException | null,
dir: Dir,
) => void

void