Class DirHandle

Directory handle object (supports async iteration)

Example

for await (const ent of dir) {
  console.log(ent.name);
}

Index

Constructors

constructor

new DirHandle(): DirHandle
Returns DirHandle

Properties

`Readonly`[toStringTag]

"[toStringTag]": "DirHandle"

`Readonly`path

path: string

Directory path

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<CModuleAsyncFS.DirEnt>
Get async iterator

Returns AsyncIterableIterator<CModuleAsyncFS.DirEnt>

close

close(): Promise<void>
Close directory

Returns Promise<void>

next(): Promise<
    | { done: false; value: CModuleAsyncFS.DirEnt }
    | { done: true; value: undefined },
>
Read next directory entry (internal use)

Returns Promise<
    | { done: false; value: CModuleAsyncFS.DirEnt }
    | { done: true; value: undefined },
>

Class DirHandle

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DirHandle

Properties

`Readonly`[toStringTag]

`Readonly`path

Methods

[asyncIterator]

Returns AsyncIterableIterator<CModuleAsyncFS.DirEnt>

close

Returns Promise<void>

next

Returns Promise<
| { done: false; value: CModuleAsyncFS.DirEnt }
| { done: true; value: undefined },
>

Settings

On This Page

Class DirHandle

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DirHandle

Properties

Readonly[toStringTag]

Readonlypath

Methods

[asyncIterator]

Returns AsyncIterableIterator<CModuleAsyncFS.DirEnt>

close

Returns Promise<void>

next

Returns Promise< | { done: false; value: CModuleAsyncFS.DirEnt } | { done: true; value: undefined },>

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`path

Returns Promise<
| { done: false; value: CModuleAsyncFS.DirEnt }
| { done: true; value: undefined },
>