CustomDir <P>

Implements

• Dir<P>

Index

Constructors

• constructor

Properties

• closed
• path

Methods

• [asyncIterator]
• close
• closeSync
• read
• readSync
• throwIfClosed

Constructors

constructor

• new CustomDir<P>(path: P, nextDirent: () => null | DirentNoPath, opts?: CustomDirOptions): CustomDir<P>

• Type parameters

  • P: Path

  Parameters

  • path: P

  • nextDirent: () => null | DirentNoPath

  • opts: CustomDirOptions = {}

  Returns CustomDir<P>

Properties

publicclosed

closed: boolean = false

publicreadonlypath

path: P

Implementation of Dir.path

Methods

[asyncIterator]

• [asyncIterator](): AsyncGenerator<DirentNoPath, void, unknown>

• Implementation of Dir.[asyncIterator]

  Returns AsyncGenerator<DirentNoPath, void, unknown>

close

• close(): Promise<void>
• close(cb: NoParamCallback): void

• Implementation of Dir.close

  Returns Promise<void>

closeSync

• closeSync(): void

• Implementation of Dir.closeSync

  Returns void

read

• read(): Promise<DirentNoPath>
• read(cb: (err: null | ErrnoException, dirent: null | DirentNoPath) => void): void

• Implementation of Dir.read

  Returns Promise<DirentNoPath>

readSync

• readSync(): null | DirentNoPath

• Implementation of Dir.readSync

  Returns null | DirentNoPath

throwIfClosed

• throwIfClosed(): void

• Returns void