Interface Iterator<T, TReturn, TNext>

An iterable iterator returned by the Node.js API.

interface Iterator<T, TReturn, TNext> {
    "[iterator]"(): Iterator<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
  • TNext

Hierarchy

  • Iterator<T, TReturn, TNext>
  • IteratorObject<T, TReturn, TNext>
    • Iterator

Methods

[iterator]

  • "[iterator]"(): Iterator<T, TReturn, TNext>

    Returns Iterator<T, TReturn, TNext>

next

  • next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>

    Parameters

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

    Returns IteratorResult<T, TReturn>

Optionalreturn

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

    Parameters

    • Optionalvalue: TReturn

    Returns IteratorResult<T, TReturn>

Optionalthrow

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

    Parameters

    • Optionale: any

    Returns IteratorResult<T, TReturn>

Settings

Member Visibility

On This Page

Methods
MMNEPVFCICPMFPCPTTAAATR