kotlin-node/node.fs/readdir

readdir

external fun readdir(path: PathLike, options: ReaddirStringOptions?, callback: (err: ErrnoException?, ReadonlyArray<String>) -> Unit)(source)

external fun readdir(path: PathLike, options: BufferEncoding?, callback: (err: ErrnoException?, ReadonlyArray<String>) -> Unit)(source)

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

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 passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects.

Since

v0.1.8

external fun readdir(path: PathLike, options: ReaddirBufferOptions, callback: (err: ErrnoException?, ReadonlyArray<Buffer>) -> Unit)(source)

external fun readdir(path: PathLike, options: String, callback: (err: ErrnoException?, ReadonlyArray<Buffer>) -> Unit)(source)

external fun readdir(path: PathLike, options: ReaddirOptions?, callback: (err: ErrnoException?, files: Any) -> Unit)(source)

external fun readdir(path: PathLike, options: BufferEncoding?, callback: (err: ErrnoException?, files: Any) -> Unit)(source)

suspend fun readdir(path: PathLike, options: String): ReadonlyArray<Buffer>(source)

suspend fun readdir(path: PathLike, options: ReaddirWithFileTypesAsyncOptions): ReadonlyArray<Dirent>(source)

Asynchronous 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 readdir(path: PathLike, callback: (err: ErrnoException?, ReadonlyArray<String>) -> Unit)(source)

Asynchronous readdir(3) - read a directory.

Parameters

path

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

external fun readdir(path: PathLike, options: ReaddirWithFileTypesOptions, callback: (err: ErrnoException?, ReadonlyArray<Dirent>) -> Unit)(source)

Asynchronous 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.

suspend fun readdir(path: PathLike): ReadonlyArray<String>(source)

suspend fun readdir(path: PathLike, options: ReaddirBufferAsyncOptions): ReadonlyArray<Buffer>(source)

suspend fun readdir(path: PathLike, options: ReaddirAsyncOptions? = undefined.unsafeCast<Nothing>()): ReadonlyArray<String>(source)

suspend fun readdir(path: PathLike, options: BufferEncoding? = undefined.unsafeCast<Nothing>()): ReadonlyArray<String>(source)

Reads the contents of a directory.

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. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the returned array will contain fs.Dirent objects.

import { readdir } from 'node:fs/promises';

try {
  const files = await readdir(path);
  for (const file of files)
    console.log(file);
} catch (err) {
  console.error(err);
}

Since

v10.0.0

Return

Fulfills with an array of the names of the files in the directory excluding '.' and '..'.