Function: readdirSync()
Call Signature
readdirSync(
path,options?):string[]
Defined in: packages/node/src/fs.ts:33
Reads the contents of the directory.
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 returned. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.
If options.withFileTypes is set to true, the result will contain fs.Dirent objects.
Parameters
path
PathLike
options?
null | BufferEncoding | {}
Returns
string[]
Since
v0.1.21
Call Signature
readdirSync(
path,options):Buffer<ArrayBufferLike>[]
Defined in: packages/node/src/fs.ts:33
Synchronous 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
Buffer<ArrayBufferLike>[]
Call Signature
readdirSync(
path,options?):string[] |Buffer<ArrayBufferLike>[]
Defined in: packages/node/src/fs.ts:33
Synchronous 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
string[] | Buffer<ArrayBufferLike>[]
Call Signature
readdirSync(
path,options):Dirent[]
Defined in: packages/node/src/fs.ts:33
Synchronous 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
Dirent[]