Search the reference...

/

function

fs.readdirSync

function readdirSync(

path: PathLike,

options?: null | BufferEncoding | { encoding: unknown; recursive: boolean; withFileTypes: false }

): 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.

function readdirSync(

path: PathLike,

options: 'buffer' | { encoding: 'buffer'; recursive: boolean; withFileTypes: false }

): Buffer<ArrayBufferLike>[];

Synchronous readdir(3) - read a directory.

@param path

A path to a file. If a URL is provided, it must use the file: protocol.

@param options

The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

function readdirSync(

path: PathLike,

options?: null | BufferEncoding | ObjectEncodingOptions & { recursive: boolean; withFileTypes: false }

): string[] | Buffer<ArrayBufferLike>[];

Synchronous readdir(3) - read a directory.

@param path

A path to a file. If a URL is provided, it must use the file: protocol.

@param options

The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.

function readdirSync(

path: PathLike,

options: ObjectEncodingOptions & { recursive: boolean; withFileTypes: true }

): Dirent<string>[];

Synchronous readdir(3) - read a directory.

@param path

A path to a file. If a URL is provided, it must use the file: protocol.

@param options

If called with withFileTypes: true the result data will be an array of Dirent.

function readdirSync(

path: PathLike,

options: { encoding: 'buffer'; recursive: boolean; withFileTypes: true }

): Dirent<Buffer<ArrayBufferLike>>[];

Synchronous readdir(3) - read a directory.

@param path

A path to a file. If a URL is provided, it must use the file: protocol.

@param options

Must include withFileTypes: true and encoding: 'buffer'.