fs.opendir(path[, options], callback)

版本历史

版本	变更
v18.0.0	将无效回调传给 `callback` 参数现在会抛出 `ERR_INVALID_ARG_TYPE` 而不是 `ERR_INVALID_CALLBACK`。
v13.1.0, v12.16.0	引入了 `bufferSize` 选项。
v12.12.0	新增于: v12.12.0

异步地打开目录。有关更多详细信息，请参阅 POSIX opendir(3) 文档。

History

Version	Changes
v18.0.0	Passing an invalid callback to the `callback` argument now throws `ERR_INVALID_ARG_TYPE` instead of `ERR_INVALID_CALLBACK`.
v13.1.0, v12.16.0	The `bufferSize` option was introduced.
v12.12.0	Added in: v12.12.0

path <string> | <Buffer> | <URL>
options <Object>
- encoding <string> | <null> Default: 'utf8'
- bufferSize <number> Number of directory entries that are buffered internally when reading from the directory. Higher values lead to better performance but higher memory usage. Default: 32
callback <Function>
- err <Error>
- dir <fs.Dir>

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.