Interface TreeIterator<T>

A tree iterator adds the ability to prune the current iteration.

interface TreeIterator<T> {
    [iterator](): IterableIterator<T>;
    next(...args: [] | [undefined]): IteratorResult<T, any>;
    prune(): void;
    return?(value?: any): IteratorResult<T, any>;
    throw?(e?: any): IteratorResult<T, any>;
}

Type Parameters

  • T

Hierarchy

  • IterableIterator<T>
    • TreeIterator

Methods

[iterator] next prune return? throw?

Methods

[iterator]

  • [iterator](): IterableIterator<T>

  • Returns IterableIterator<T>

next

  • next(...args): IteratorResult<T, any>

  • Parameters

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

    Returns IteratorResult<T, any>

prune

Optionalreturn

  • return(value?): IteratorResult<T, any>

  • Parameters

    • Optionalvalue: any

    Returns IteratorResult<T, any>

Optionalthrow

  • throw(e?): IteratorResult<T, any>

  • Parameters

    • Optionale: any

    Returns IteratorResult<T, any>

Settings

Member Visibility

On This Page

Methods