Interface IterableIterator<T, TReturn, TNext>

Describes a user-defined Iterator that is also iterable.

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

Type Parameters

  • T
  • TReturn = any
  • TNext = any

Hierarchy

Methods

[iterator] next return? throw?

Methods

[iterator]

next

  • next(...__namedParameters): IteratorResult<T, TReturn>

  • Parameters

    • Rest...__namedParameters: [] | [TNext]

    Returns IteratorResult<T, TReturn>

Optionalreturn

Optionalthrow

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

  • Parameters

    • Optionale: any

    Returns IteratorResult<T, TReturn>

Settings

Member Visibility

On This Page

Methods