Jump to headingreaddirSync(path: PathLike,options?: { encoding: BufferEncoding | null; withFileTypes?: false | undefined; recursive?: boolean | undefined; }
| BufferEncoding
| null,): 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 Jump to heading
Jump to headingpath: PathLikeJump to headingoptions: { encoding: BufferEncoding | null; withFileTypes?: false | undefined; recursive?: boolean | undefined; }
| BufferEncoding
| nullReturn Type Jump to heading
string[]Jump to headingreaddirSync(path: PathLike,options: { encoding: "buffer"; withFileTypes?: false | undefined; recursive?: boolean | undefined; } | "buffer",): Buffer[]Synchronous readdir(3) - read a directory.
Parameters Jump to heading
Jump to headingpath: PathLikeA path to a file. If a URL is provided, it must use the file: protocol.
Jump to headingoptions: { encoding: "buffer"; withFileTypes?: false | undefined; recursive?: boolean | undefined; } | "buffer"The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Return Type Jump to heading
Buffer[]Jump to headingreaddirSync(path: PathLike,options?: (ObjectEncodingOptions & { withFileTypes?: false | undefined; recursive?: boolean | undefined; })
| BufferEncoding
| null,): string[] | Buffer[]Synchronous readdir(3) - read a directory.
Parameters Jump to heading
Jump to headingpath: PathLikeA path to a file. If a URL is provided, it must use the file: protocol.
Jump to headingoptions: (ObjectEncodingOptions & { withFileTypes?: false | undefined; recursive?: boolean | undefined; })
| BufferEncoding
| nullThe encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Return Type Jump to heading
string[] | Buffer[]Jump to headingreaddirSync(path: PathLike,options: ObjectEncodingOptions & { withFileTypes: true; recursive?: boolean | undefined; },): Dirent[]Synchronous readdir(3) - read a directory.
Parameters Jump to heading
Jump to headingpath: PathLikeA path to a file. If a URL is provided, it must use the file: protocol.
Jump to headingoptions: ObjectEncodingOptions & { withFileTypes: true; recursive?: boolean | undefined; }If called with withFileTypes: true the result data will be an array of Dirent.
Return Type Jump to heading
Dirent[]