Interface DirHandle

Directory entries can be obtained through asynchronous iteration:

const dirIter = await tjs.readdir('.');
for await (const item of dirIter) {
    console.log(item.name);
}

Hierarchy

  • AsyncIterableIterator<DirEnt>
    • DirHandle

Properties

path

Methods

[asyncIterator] close next return? throw?

Properties

path

path: string

Path of the directory.

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<DirEnt>

  • Returns AsyncIterableIterator<DirEnt>

close

  • Closes the directory handle.

    Returns Promise<void>

next

  • Parameters

    • Rest ...args: [] | [undefined]

    Returns Promise<IteratorResult<DirEnt, any>>

Optional return

  • Parameters

    • Optional value: any

    Returns Promise<IteratorResult<DirEnt, any>>

Optional throw

  • Parameters

    • Optional e: any

    Returns Promise<IteratorResult<DirEnt, any>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc