Interface ArrayIterator<T>

interface ArrayIterator<T> {
    next(...__namedParameters: [] | [unknown]): IteratorResult<T, any>;
    return?(value?: any): IteratorResult<T, any>;
    throw?(e?: any): IteratorResult<T, any>;
    [iterator](): ArrayIterator<T>;
    [dispose](): void;
    [dispose](): void;
    map<U>(callbackfn: ((value: T, index: number) => U)): IteratorObject<U, undefined, unknown>;
    filter<S>(predicate: ((value: T, index: number) => value is S)): IteratorObject<S, undefined, unknown>;
    filter(predicate: ((value: T, index: number) => unknown)): IteratorObject<T, undefined, unknown>;
    take(limit: number): IteratorObject<T, undefined, unknown>;
    drop(count: number): IteratorObject<T, undefined, unknown>;
    flatMap<U>(callback: ((value: T, index: number) => Iterator<U, unknown, undefined> | Iterable<U, unknown, undefined>)): IteratorObject<U, undefined, unknown>;
    reduce(callbackfn: ((previousValue: T, currentValue: T, currentIndex: number) => T)): T;
    reduce(callbackfn: ((previousValue: T, currentValue: T, currentIndex: number) => T), initialValue: T): T;
    reduce<U>(callbackfn: ((previousValue: U, currentValue: T, currentIndex: number) => U), initialValue: U): U;
    toArray(): T[];
    forEach(callbackfn: ((value: T, index: number) => void)): void;
    some(predicate: ((value: T, index: number) => unknown)): boolean;
    every(predicate: ((value: T, index: number) => unknown)): boolean;
    find<S>(predicate: ((value: T, index: number) => value is S)): S;
    find(predicate: ((value: T, index: number) => unknown)): T;
    [toStringTag]: string;
}

Type Parameters

  • T

Hierarchy

Properties

[toStringTag]

Methods

next return? throw? [iterator] [dispose] map filter take drop flatMap reduce toArray forEach some every find

Properties

Readonly[toStringTag]

[toStringTag]: string

Methods

next

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

  • Parameters

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

    Returns IteratorResult<T, any>

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>

[iterator]

  • [iterator](): ArrayIterator<T>

  • Returns ArrayIterator<T>

[dispose]

  • [dispose](): void

  • Returns void

  • [dispose](): void

  • Returns void

map

  • map<U>(callbackfn): IteratorObject<U, undefined, unknown>

  • Creates an iterator whose values are the result of applying the callback to the values from this iterator.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((value: T, index: number) => U)

      A function that accepts up to two arguments to be used to transform values from the underlying iterator.

        • (value, index): U

        • Parameters

          • value: T
          • index: number

          Returns U

    Returns IteratorObject<U, undefined, unknown>

filter

  • filter<S>(predicate): IteratorObject<S, undefined, unknown>

  • Creates an iterator whose values are those from this iterator for which the provided predicate returns true.

    Type Parameters

    • S

    Parameters

    • predicate: ((value: T, index: number) => value is S)

      A function that accepts up to two arguments to be used to test values from the underlying iterator.

        • (value, index): value is S

        • Parameters

          • value: T
          • index: number

          Returns value is S

    Returns IteratorObject<S, undefined, unknown>

  • filter(predicate): IteratorObject<T, undefined, unknown>

  • Creates an iterator whose values are those from this iterator for which the provided predicate returns true.

    Parameters

    • predicate: ((value: T, index: number) => unknown)

      A function that accepts up to two arguments to be used to test values from the underlying iterator.

        • (value, index): unknown

        • Parameters

          • value: T
          • index: number

          Returns unknown

    Returns IteratorObject<T, undefined, unknown>

take

  • take(limit): IteratorObject<T, undefined, unknown>

  • Creates an iterator whose values are the values from this iterator, stopping once the provided limit is reached.

    Parameters

    • limit: number

      The maximum number of values to yield.

    Returns IteratorObject<T, undefined, unknown>

drop

  • drop(count): IteratorObject<T, undefined, unknown>

  • Creates an iterator whose values are the values from this iterator after skipping the provided count.

    Parameters

    • count: number

      The number of values to drop.

    Returns IteratorObject<T, undefined, unknown>

flatMap

  • flatMap<U>(callback): IteratorObject<U, undefined, unknown>

  • Creates an iterator whose values are the result of applying the callback to the values from this iterator and then flattening the resulting iterators or iterables.

    Type Parameters

    • U

    Parameters

    • callback: ((value: T, index: number) => Iterator<U, unknown, undefined> | Iterable<U, unknown, undefined>)

      A function that accepts up to two arguments to be used to transform values from the underlying iterator into new iterators or iterables to be flattened into the result.

        • (value, index): Iterator<U, unknown, undefined> | Iterable<U, unknown, undefined>

        • Parameters

          • value: T
          • index: number

          Returns Iterator<U, unknown, undefined> | Iterable<U, unknown, undefined>

    Returns IteratorObject<U, undefined, unknown>

reduce

  • reduce(callbackfn): T

  • Calls the specified callback function for all the elements in this iterator. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: ((previousValue: T, currentValue: T, currentIndex: number) => T)

      A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.

        • (previousValue, currentValue, currentIndex): T

        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number

          Returns T

    Returns T

  • reduce(callbackfn, initialValue): T

  • Parameters

    • callbackfn: ((previousValue: T, currentValue: T, currentIndex: number) => T)
        • (previousValue, currentValue, currentIndex): T

        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number

          Returns T

    • initialValue: T

    Returns T

  • reduce<U>(callbackfn, initialValue): U

  • Calls the specified callback function for all the elements in this iterator. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type Parameters

    • U

    Parameters

    • callbackfn: ((previousValue: U, currentValue: T, currentIndex: number) => U)

      A function that accepts up to three arguments. The reduce method calls the callbackfn function one time for each element in the iterator.

        • (previousValue, currentValue, currentIndex): U

        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of a value from the iterator.

    Returns U

toArray

  • toArray(): T[]

  • Creates a new array from the values yielded by this iterator.

    Returns T[]

forEach

  • forEach(callbackfn): void

  • Performs the specified action for each element in the iterator.

    Parameters

    • callbackfn: ((value: T, index: number) => void)

      A function that accepts up to two arguments. forEach calls the callbackfn function one time for each element in the iterator.

        • (value, index): void

        • Parameters

          • value: T
          • index: number

          Returns void

    Returns void

some

  • some(predicate): boolean

  • Determines whether the specified callback function returns true for any element of this iterator.

    Parameters

    • predicate: ((value: T, index: number) => unknown)

      A function that accepts up to two arguments. The some method calls the predicate function for each element in this iterator until the predicate returns a value true, or until the end of the iterator.

        • (value, index): unknown

        • Parameters

          • value: T
          • index: number

          Returns unknown

    Returns boolean

every

  • every(predicate): boolean

  • Determines whether all the members of this iterator satisfy the specified test.

    Parameters

    • predicate: ((value: T, index: number) => unknown)

      A function that accepts up to two arguments. The every method calls the predicate function for each element in this iterator until the predicate returns false, or until the end of this iterator.

        • (value, index): unknown

        • Parameters

          • value: T
          • index: number

          Returns unknown

    Returns boolean

find

  • find<S>(predicate): S

  • Returns the value of the first element in this iterator where predicate is true, and undefined otherwise.

    Type Parameters

    • S

    Parameters

    • predicate: ((value: T, index: number) => value is S)

      find calls predicate once for each element of this iterator, in order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (value, index): value is S

        • Parameters

          • value: T
          • index: number

          Returns value is S

    Returns S

  • find(predicate): T

  • Parameters

    • predicate: ((value: T, index: number) => unknown)
        • (value, index): unknown

        • Parameters

          • value: T
          • index: number

          Returns unknown

    Returns T

Settings

Member Visibility

On This Page

Properties
Methods