fs.readdir(path[, options], callback)
path
<string> | <Buffer> | <URL>options
<string> | <Object>callback
<Function>err
<Error>files
<string[]> | <Buffer[]> | <fs.Dirent[]>
异步的 readdir(3)
。
读取目录的内容。
回调有两个参数 (err, files)
,其中 files
是目录中文件名的数组,不包括 '.'
和 '..'
。
可选的 options
参数可以是指定编码的字符串,也可以是具有 encoding
属性(指定用于传给回调的文件名的字符编码)的对象。
如果 encoding
设置为 'buffer'
,则返回的文件名将作为 Buffer
对象传入。
如果 options.withFileTypes
设置为 true
,则 files
数组将包含 fs.Dirent
对象。
path
<string> | <Buffer> | <URL>options
<string> | <Object>callback
<Function>err
<Error>files
<string[]> | <Buffer[]> | <fs.Dirent[]>
Asynchronous readdir(3)
. 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 '..'
.
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.
If options.withFileTypes
is set to true
, the files
array will contain
fs.Dirent
objects.