Class Dir

constructor

• new Dir(link: Link, options: IOpendirOptions): Dir

  Parameters

  • link: Link
  • options: IOpendirOptions

  Returns Dir

Readonlypath

[asyncIterator]

• "[asyncIterator]"(): AsyncIterableIterator<IDirent>

  Returns AsyncIterableIterator<IDirent>

close

• close(): Promise<void>

  Returns Promise<void>

• close(callback?: (err?: Error) => void): void

  Parameters

  • Optionalcallback: (err?: Error) => void

  Returns void

closeSync

• closeSync(): void

  Returns void

read

• read(): Promise<IDirent | null>

  Returns Promise<IDirent | null>

• read(callback?: (err: Error | null, dir?: IDirent | null) => void): void

  Parameters

  • Optionalcallback: (err: Error | null, dir?: IDirent | null) => void

  Returns void

readSync

• readSync(): IDirent | null

  Returns IDirent | null