Function readdir

readdir(
    path: PathLike,
    options?:
        | BufferEncoding
        | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
): Promise<string[]>
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);
}
```
Parameters
- path: PathLike
- Optionaloptions:
  | BufferEncoding
  | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false }
Returns Promise<string[]>
Fulfills with an array of the names of the files in the directory excluding '.' and '..'.

Since
v10.0.0
- Defined in node_modules/@types/node/fs/promises.d.ts:669
readdir(
    path: PathLike,
    options:
        | "buffer"
        | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false },
): Promise<Buffer<ArrayBufferLike>[]>
Asynchronous 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" | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false }
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns Promise<Buffer<ArrayBufferLike>[]>
- Defined in node_modules/@types/node/fs/promises.d.ts:684
readdir(
    path: PathLike,
    options?:
        | BufferEncoding
        | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
): Promise<string[] | Buffer<ArrayBufferLike>[]>
Asynchronous readdir(3) - read a directory.
Parameters
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions:
  | BufferEncoding
  | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false }
  The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, 'utf8' is used.
Returns Promise<string[] | Buffer<ArrayBufferLike>[]>
- Defined in node_modules/@types/node/fs/promises.d.ts:699
readdir(
    path: PathLike,
    options: ObjectEncodingOptions & {
        recursive?: boolean;
        withFileTypes: true;
    },
): Promise<Dirent<string>[]>
Asynchronous 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 & { recursive?: boolean; withFileTypes: true }
  If called with withFileTypes: true the result data will be an array of Dirent.
Returns Promise<Dirent<string>[]>
- Defined in node_modules/@types/node/fs/promises.d.ts:714
readdir(
path: PathLike,
options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
): Promise<Dirent<Buffer<ArrayBufferLike>>[]>
Asynchronous readdir(3) - read a directory.
Parameters
- path: PathLike
  A path to a directory. If a URL is provided, it must use the file: protocol.
- options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true }
  Must include withFileTypes: true and encoding: 'buffer'.
Returns Promise<Dirent<Buffer<ArrayBufferLike>>[]>
- Defined in node_modules/@types/node/fs/promises.d.ts:726

Function readdir

Parameters

Returns Promise<string[]>

Since

Parameters

Returns Promise<Buffer<ArrayBufferLike>[]>

Parameters

Returns Promise<string[] | Buffer<ArrayBufferLike>[]>

Parameters

Returns Promise<Dirent<string>[]>

Parameters

Returns Promise<Dirent<Buffer<ArrayBufferLike>>[]>

Settings