Interface TreeIterator<T>

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

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

Type Parameters

Hierarchy

IterableIterator<T>
- TreeIterator

Index

Methods

[iterator] next prune return? throw?

Methods

[iterator]

"[iterator]"(): IterableIterator<T, any, any>
Returns IterableIterator<T, any, any>
Inherited from IterableIterator.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:56

next(...__namedParameters: [] | [any]): IteratorResult<T, any>
Parameters
- ...__namedParameters: [] | [any]
Returns IteratorResult<T, any>
Inherited from IterableIterator.next
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:43

prune

prune(): void
Skip the whole subtree below the last returned element. The iteration continues as if that element had no children.

Returns void
- Defined in packages/langium/src/utils/stream.ts:782

`Optional`return

return(value?: any): IteratorResult<T, any>
Parameters
- Optionalvalue: any
Returns IteratorResult<T, any>
Inherited from IterableIterator.return
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:44

`Optional`throw

throw(e?: any): IteratorResult<T, any>
Parameters
- Optionale: any
Returns IteratorResult<T, any>
Inherited from IterableIterator.throw
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:45

Interface TreeIterator<T>

Type Parameters

Hierarchy

Index

Methods

Methods

[iterator]

Returns IterableIterator<T, any, any>

next

Parameters

Returns IteratorResult<T, any>

prune

Returns void

`Optional`return

Parameters

Returns IteratorResult<T, any>

`Optional`throw

Parameters

Returns IteratorResult<T, any>

Settings

On This Page

Interface TreeIterator<T>

Type Parameters

Hierarchy

Index

Methods

Methods

[iterator]

Returns IterableIterator<T, any, any>

next

Parameters

Returns IteratorResult<T, any>

prune

Returns void

Optionalreturn

Parameters

Returns IteratorResult<T, any>

Optionalthrow

Parameters

Returns IteratorResult<T, any>

Settings

On This Page

`Optional`return

`Optional`throw