readdirSync

external fun readdirSync(path: PathLike): <Error class: unknown class><String>(source)

external fun readdirSync(path: PathLike, options: ReaddirSyncStringOptions? = definedExternally): <Error class: unknown class><String>(source)

external fun readdirSync(path: PathLike, options: BufferEncoding? = definedExternally): <Error class: unknown class><String>(source)

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.

Since

v0.1.21

external fun readdirSync(path: PathLike, options: ReaddirSyncBufferOptions): <Error class: unknown class><Buffer<*>>(source)

external fun readdirSync(path: PathLike, options: String): <Error class: unknown class><Buffer<*>>(source)

external fun readdirSync(path: PathLike, options: ReaddirSyncOptions? = definedExternally): Any(source)

Synchronous readdir(3) - read a directory.

Parameters

path

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.

external fun readdirSync(path: PathLike, options: ReaddirSyncWithFileTypesOptions): <Error class: unknown class><Dirent>(source)

Synchronous readdir(3) - read a directory.

Parameters

path

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

options

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