Function readdirSync

readdirSync(
    path: PathLike,
    options?:
        | BufferEncoding
        | { encoding: BufferEncoding; 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.
Parameters
- path: PathLike
- Optionaloptions:
  | BufferEncoding
  | { encoding: BufferEncoding; recursive?: boolean; withFileTypes?: false }
Returns string[]
Since
v0.1.21
- Defined in node_modules/@types/node/fs.d.ts:2143
readdirSync(
    path: PathLike,
    options:
        | "buffer"
        | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false },
): Buffer<ArrayBufferLike>[]
Synchronous 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 Buffer<ArrayBufferLike>[]
- Defined in node_modules/@types/node/fs.d.ts:2159
readdirSync(
    path: PathLike,
    options?:
        | BufferEncoding
        | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
): string[] | Buffer<ArrayBufferLike>[]
Synchronous 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 string[] | Buffer<ArrayBufferLike>[]
- Defined in node_modules/@types/node/fs.d.ts:2174
readdirSync(
    path: PathLike,
    options: ObjectEncodingOptions & {
        recursive?: boolean;
        withFileTypes: true;
    },
): Dirent<string>[]
Synchronous 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 Dirent<string>[]
- Defined in node_modules/@types/node/fs.d.ts:2189
readdirSync(
path: PathLike,
options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
): Dirent<Buffer<ArrayBufferLike>>[]
Synchronous 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: { encoding: "buffer"; recursive?: boolean; withFileTypes: true }
  Must include withFileTypes: true and encoding: 'buffer'.
Returns Dirent<Buffer<ArrayBufferLike>>[]
- Defined in node_modules/@types/node/fs.d.ts:2201

Function readdirSync

Parameters

Returns string[]

Since

Parameters

Returns Buffer<ArrayBufferLike>[]

Parameters

Returns string[] | Buffer<ArrayBufferLike>[]

Parameters

Returns Dirent<string>[]

Parameters

Returns Dirent<Buffer<ArrayBufferLike>>[]

Settings