Globals

Class CustomDir<P>

Type parameters

P: Path

Hierarchy

CustomDir

Implements

object

Constructors

constructor

Properties

Methods

Constructors

constructor

new CustomDir(path: P, nextDirent: function, opts?: CustomDirOptions): CustomDir

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:11
Parameters
- path: P
- nextDirent: function
  - - (): Dirent | null
    - Returns Dirent | null
- Default value opts: CustomDirOptions = {}
Returns CustomDir

Properties

closed

closed: boolean = false

Private nextDirent

nextDirent: function

Type declaration

- (): Dirent | null
- Returns Dirent | null

Private opts

opts: CustomDirOptions

path

path: P

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncGenerator<Dirent & object, void, unknown>

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:26
Returns AsyncGenerator<Dirent & object, void, unknown>

close

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

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:55
Returns Promise<void>
- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:56
Parameters
- cb: NoParamCallback
Returns void

closeSync

closeSync(): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:66
Returns void

read

read(): Promise<Dirent>
read(cb: function): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:38
Returns Promise<Dirent>
- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:39
Parameters
- cb: function
  - - (err: ErrnoException | null, dirent: Dirent | null): void
    - Parameters
      - err: ErrnoException | null
      - dirent: Dirent | null
      Returns void
Returns void

readSync

readSync(): null | Dirent & object

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:49
Returns null | Dirent & object

throwIfClosed

throwIfClosed(): void

- Defined in packages/yarnpkg-fslib/sources/algorithms/opendir.ts:20
Returns void

Generated using TypeDoc