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

版本历史

版本	变更
v20.1.0	Added `recursive` option.
v18.0.0	Passing an invalid callback to the `callback` argument now throws `ERR_INVALID_ARG_TYPE` instead of `ERR_INVALID_CALLBACK`.
v10.10.0	New option `withFileTypes` was added.
v10.0.0	The `callback` parameter is no longer optional. Not passing it will throw a `TypeError` at runtime.
v7.6.0	The `path` parameter can be a WHATWG `URL` object using `file:` protocol.
v7.0.0	The `callback` parameter is no longer optional. Not passing it will emit a deprecation warning with id DEP0013.
v6.0.0	The `options` parameter was added.
v0.1.8	新增于: v0.1.8

path <string> | <Buffer> | <URL>
options <string> | <Object>
- encoding <string> 默认值: 'utf8'
- withFileTypes <boolean> 默认值: false
- recursive <boolean> 如果为 true，将递归读取目录内容。在递归模式下，它会列出所有文件、子文件和目录。默认值： false。
callback <Function>
- err <Error>
- files <string[]> | <Buffer[]> | <fs.Dirent[]>

读取目录的内容。回调函数接收两个参数 (err, files)，其中 files 是目录中除 '.' 和 '..' 之外的文件名数组。

【Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.】

有关更多详细信息，请参阅 POSIX readdir(3) 文档。

【See the POSIX readdir(3) documentation for more details.】

可选的 options 参数可以是指定编码的字符串，也可以是带有 encoding 属性的对象，用于指定传递给回调函数的文件名使用的字符编码。如果 encoding 设置为 'buffer'，返回的文件名将作为 <Buffer> 对象传递。

【The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as <Buffer> objects.】

如果将 options.withFileTypes 设置为 true，则 files 数组将包含 <fs.Dirent> 对象。

【If options.withFileTypes is set to true, the files array will contain <fs.Dirent> objects.】