@vtj • Docs
Function: readdirSync()
readdirSync(path, options)
readdirSync(
path,options?):string[]
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 | object
Returns
string[]
Since
v0.1.21
Defined in
packages/node/src/fs.ts:33
readdirSync(path, options)
readdirSync(
path,options):Buffer[]
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: "buffer" | object
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns
Buffer[]
Defined in
packages/node/src/fs.ts:33
readdirSync(path, options)
readdirSync(
path,options?):string[] |Buffer[]
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?: null | BufferEncoding | ObjectEncodingOptions & object
The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns
string[] | Buffer[]
Defined in
packages/node/src/fs.ts:33
readdirSync(path, options)
readdirSync(
path,options):Dirent[]
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[]
Defined in
packages/node/src/fs.ts:33