Function opendir

opendir(path: PathLike, callback: OpenDirCallback): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- callback: OpenDirCallback
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:1963
opendir(path: PathLike, options: OpenDirOptions, callback: OpenDirCallback): void
Open a directory.
Parameters
- path: PathLike
  
  directory path
- options: OpenDirOptions
  
  opendir options {encoding, bufferSize}
- callback: OpenDirCallback
  
  callback (err, dir)
Returns void
- Defined in src/index.ts:1971
opendir(path: PathLike, options?: OpenDirOptions): Promise<Dir>
Open a directory.

Returns
directory stream
Parameters
- path: PathLike
  
  directory path
- Optional options: OpenDirOptions
  
  opendir options {encoding, bufferSize}
Returns Promise<Dir>
- Defined in src/index.ts:1979

Generated using TypeDoc