Function aggregate

  • Applies an accumulator function over a sequence.

    Typeparam

    TSource The type of the elements of source.

    Returns

    The final accumulator value.

    Type Parameters

    • TSource

    Parameters

    • src: Iterable<TSource>

      An Enumerable to aggregate over.

    • aggregator: ((prev: TSource, curr: TSource, index: number) => TSource)

      An accumulator function to be invoked on each element.

        • (prev: TSource, curr: TSource, index: number): TSource

        • Parameters

          • prev: TSource
          • curr: TSource
          • index: number

          Returns TSource

    Returns TSource

  • Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value.

    Typeparam

    TSource The type of the elements of source.

    Typeparam

    TAccumulate The type of the accumulator value.

    Returns

    The final accumulator value.

    Type Parameters

    • TSource

    • TAccumulate

    Parameters

    • src: Iterable<TSource>

      An Enumerable to aggregate over.

    • seed: TAccumulate

      The initial accumulator value.

    • aggregator: ((prev: TAccumulate, curr: TSource, index: number) => TAccumulate)

      An accumulator function to be invoked on each element.

        • (prev: TAccumulate, curr: TSource, index: number): TAccumulate

        • Parameters

          • prev: TAccumulate
          • curr: TSource
          • index: number

          Returns TAccumulate

    Returns TAccumulate

  • Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value, and the specified function is used to select the result value.

    Typeparam

    TSource The type of the elements of source.

    Typeparam

    TAccumulate The type of the accumulator value.

    Typeparam

    TResult The type of the resulting value.

    Returns

    The final accumulator value.

    Type Parameters

    • TSource

    • TAccumulate

    • TResult

    Parameters

    • src: Iterable<TSource>

      An Enumerable to aggregate over.

    • seed: TAccumulate

      The initial accumulator value.

    • aggregator: ((prev: TAccumulate, curr: TSource, index: number) => TAccumulate)

      An accumulator function to be invoked on each element.

        • (prev: TAccumulate, curr: TSource, index: number): TAccumulate

        • Parameters

          • prev: TAccumulate
          • curr: TSource
          • index: number

          Returns TAccumulate

    • resultSelector: ((accumulated: TAccumulate) => TResult)

      An accumulator function to be invoked on each element.

        • (accumulated: TAccumulate): TResult

        • Parameters

          • accumulated: TAccumulate

          Returns TResult

    Returns TResult

  • Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value, and the specified function is used to select the result value.

    Typeparam

    TSource The type of the elements of source.

    Typeparam

    TAccumulate The type of the accumulator value.

    Typeparam

    TResult The type of the resulting value.

    Returns

    The final accumulator value.

    Type Parameters

    • TSource

    • TAccumulate

    • TResult

    Parameters

    • src: Iterable<TSource>

      An Enumerable to aggregate over.

    • seedOrAggregator: TSource | TAccumulate | ((prev: TSource | TAccumulate, curr: TSource, index: number) => TSource | TAccumulate)
    • Optional aggregator: ((prev: TSource | TAccumulate, curr: TSource, index: number) => TSource | TAccumulate)

      An accumulator function to be invoked on each element.

        • (prev: TSource | TAccumulate, curr: TSource, index: number): TSource | TAccumulate

        • Parameters

          • prev: TSource | TAccumulate
          • curr: TSource
          • index: number

          Returns TSource | TAccumulate

    • Optional resultSelector: ((accumulated: TAccumulate) => TResult)

      An accumulator function to be invoked on each element.

        • (accumulated: TAccumulate): TResult

        • Parameters

          • accumulated: TAccumulate

          Returns TResult

    Returns TAccumulate | TSource | TResult

Settings

Member Visibility

Theme

Generated using TypeDoc