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

版本历史

版本	变更
v20.1.0	添加了 `recursive` 选项。
v18.0.0	将无效回调传给 `callback` 参数现在会抛出 `ERR_INVALID_ARG_TYPE` 而不是 `ERR_INVALID_CALLBACK`。
v10.10.0	添加了新选项 `withFileTypes`。
v10.0.0	参数 `callback` 不再是可选的。不传入它会在运行时抛出 `TypeError`。
v7.6.0	参数 `path` 可以是使用 `file:` 协议的 WHATWG `URL` 对象。
v7.0.0	参数 `callback` 不再是可选的。不传入它将触发 ID 为 DEP0013 的弃用警告。
v6.0.0	添加了 `options` 参数。
v0.1.8	新增于: v0.1.8

path <string> | <Buffer> | <URL>
options <string> | <Object>
- encoding <string> 默认值：'utf8'
  
  ¥encoding <string> Default: 'utf8'
- withFileTypes <boolean> 默认值：false
  
  ¥withFileTypes <boolean> Default: false
- recursive <boolean> 如果是 true，则递归读取目录的内容。在递归模式下，它将列出所有文件、子文件和目录。默认值：false。
  
  ¥recursive <boolean> If true, reads the contents of a directory recursively. In recursive mode, it will list all files, sub files and directories. Default: 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.