Function: readdir()
Call Signature
readdir(
path,options?):Promise<string[]>
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options?
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
null | BufferEncoding | {}
Returns
Promise<string[]>
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options):Promise<Buffer[]>
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
"buffer" | {}
Returns
Promise<Buffer[]>
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options?):Promise<string[] |Buffer[]>
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options?
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
null | BufferEncoding | ObjectEncodingOptions & object
Returns
Promise<string[] | Buffer[]>
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options):Promise<Dirent[]>
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options
ObjectEncodingOptions & object
If called with withFileTypes: true the result data will be an array of Dirent
Returns
Promise<Dirent[]>
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options,callback):void
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 '..'.
See the POSIX readdir(3) documentation for more details.
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.
Parameters
path
PathLike
options
undefined | null | BufferEncoding | {}
callback
(err, files) => void
Returns
void
Since
v0.1.8
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options,callback):void
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
"buffer" | {}
callback
(err, files) => void
Returns
void
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options,callback):void
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
undefined | null | BufferEncoding | ObjectEncodingOptions & object
callback
(err, files) => void
Returns
void
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,callback):void
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
callback
(err, files) => void
Returns
void
Defined in
packages/node/src/fs.ts:32
Call Signature
readdir(
path,options,callback):void
Asynchronous readdir(3) - read a directory.
Parameters
path
PathLike
A path to a file. If a URL is provided, it must use the file: protocol.
options
ObjectEncodingOptions & object
If called with withFileTypes: true the result data will be an array of Dirent.
callback
(err, files) => void
Returns
void
Defined in
packages/node/src/fs.ts:32