opendirAsync
external fun opendirAsync(path: PathLike, options: OpenDirOptions = definedExternally): Promise<Dir>(source)
Asynchronously open a directory for iterative scanning. See the POSIX opendir(3)
documentation for more detail.
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.
Example using async iteration:
import { opendir } from 'node:fs/promises';
try {
const dir = await opendir('./');
for await (const dirent of dir)
console.log(dirent.name);
} catch (err) {
console.error(err);
}
Content copied to clipboard
When using the async iterator, the fs.Dir
object will be automatically closed after the iterator exits.
Since
v12.12.0
Return
Fulfills with an {fs.Dir}.