Function readdir

readdir(path: PathLike, callback: ReadDirCallback<string[]>): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- callback: ReadDirCallback<string[]>
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:2019
readdir(path: PathLike, options: BufferEncoding | {
encoding: BufferEncoding;
withFileTypes?: false;
}, callback: ReadDirCallback<string[]>): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: BufferEncoding | {
  encoding: BufferEncoding;
  withFileTypes?: false;
  }
  
  readdir options {encoding, withFileTypes}
- callback: ReadDirCallback<string[]>
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:2027
readdir(path: PathLike, options: "buffer" | {
encoding: "buffer";
withFileTypes?: false;
}, callback: ReadDirCallback<Buffer[]>): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: "buffer" | {
  encoding: "buffer";
  withFileTypes?: false;
  }
  
  readdir options {encoding, withFileTypes}
- callback: ReadDirCallback<Buffer[]>
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:2035
readdir(path: PathLike, options: BufferEncoding | ObjectEncodingOptions & {
withFileTypes?: false;
}, callback: ReadDirCallback<string[]>): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: BufferEncoding | ObjectEncodingOptions & {
  withFileTypes?: false;
  }
  
  readdir options {encoding, withFileTypes}
- callback: ReadDirCallback<string[]>
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:2043
readdir(path: PathLike, options: ObjectEncodingOptions & {
withFileTypes: true;
}, callback: ReadDirCallback<Dirent[]>): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: ObjectEncodingOptions & {
  withFileTypes: true;
  }
  
  readdir options {encoding, withFileTypes}
- callback: ReadDirCallback<Dirent[]>
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:2051
readdir(path: PathLike): Promise<string[]>
Open a directory.
Parameters
- path: PathLike
  
  directory path
Returns Promise<string[]>
- Defined in src/index.ts:2057
readdir(path: PathLike, options: BufferEncoding | {
encoding: BufferEncoding;
withFileTypes?: false;
}): Promise<string[]>
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: BufferEncoding | {
  encoding: BufferEncoding;
  withFileTypes?: false;
  }
  
  readdir options {encoding, withFileTypes}
Returns Promise<string[]>
- Defined in src/index.ts:2064
readdir(path: PathLike, options: "buffer" | {
encoding: "buffer";
withFileTypes?: false;
}): Promise<Buffer[]>
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: "buffer" | {
  encoding: "buffer";
  withFileTypes?: false;
  }
  
  readdir options {encoding, withFileTypes}
Returns Promise<Buffer[]>
- Defined in src/index.ts:2071
readdir(path: PathLike, options: BufferEncoding | ObjectEncodingOptions & {
withFileTypes?: false;
}): Promise<string[]>
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: BufferEncoding | ObjectEncodingOptions & {
  withFileTypes?: false;
  }
  
  readdir options {encoding, withFileTypes}
Returns Promise<string[]>
- Defined in src/index.ts:2078
readdir(path: PathLike, options: ObjectEncodingOptions & {
withFileTypes: true;
}): Promise<Dirent[]>
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: ObjectEncodingOptions & {
  withFileTypes: true;
  }
  
  readdir options {encoding, withFileTypes}
Returns Promise<Dirent[]>
- Defined in src/index.ts:2085

Function readdir

Parameters

path: PathLike

callback: ReadDirCallback<string[]>

Returns void

Parameters

path: PathLike

options: BufferEncoding | { encoding: BufferEncoding; withFileTypes?: false; }

callback: ReadDirCallback<string[]>

Returns void

Parameters

path: PathLike

options: "buffer" | { encoding: "buffer"; withFileTypes?: false; }

callback: ReadDirCallback<Buffer[]>

Returns void

Parameters

path: PathLike

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

callback: ReadDirCallback<string[]>

Returns void

Parameters

path: PathLike

options: ObjectEncodingOptions & { withFileTypes: true; }

callback: ReadDirCallback<Dirent[]>

Returns void

Parameters

path: PathLike

Returns Promise<string[]>

Parameters

path: PathLike

options: BufferEncoding | { encoding: BufferEncoding; withFileTypes?: false; }

Returns Promise<string[]>

Parameters

path: PathLike

options: "buffer" | { encoding: "buffer"; withFileTypes?: false; }

Returns Promise<Buffer[]>

Parameters

path: PathLike

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

Returns Promise<string[]>

Parameters

path: PathLike

options: ObjectEncodingOptions & { withFileTypes: true; }

Returns Promise<Dirent[]>

Settings

Member Visibility

Theme

options: BufferEncoding | {
encoding: BufferEncoding;
withFileTypes?: false;
}

options: "buffer" | {
encoding: "buffer";
withFileTypes?: false;
}

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

options: ObjectEncodingOptions & {
withFileTypes: true;
}

options: BufferEncoding | {
encoding: BufferEncoding;
withFileTypes?: false;
}

options: "buffer" | {
encoding: "buffer";
withFileTypes?: false;
}

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

options: ObjectEncodingOptions & {
withFileTypes: true;
}