Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "aggregation/Aggregators"

Index

Functions

count

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns CountAggregator

    an aggregator that counts the input values. Accepts nulls as input values. Aggregation result type Long.

doubleAvg

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns DoubleAverageAggregator

    an aggregator that calculates the average of the input values. Does NOT accept null input values. Accepts only Double input values (primitive and boxed). Aggregation result type is number.

doubleSum

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns DoubleSumAggregator

    an aggregator that calculates the sum of the input values. Does NOT accept null input values. Accepts only Double input values (primitive and boxed). Aggregation result type is Double.

fixedPointSum

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns FixedPointSumAggregator

    an aggregator that calculates the sum of the input values. Does NOT accept null input values. Accepts generic Number input values. Aggregation result type is {Long}.

floatingPointSum

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns FloatingPointSumAggregator

    an aggregator that calculates the sum of the input values. Does NOT accept null input values. Accepts generic Number input values. Aggregation result type is number.

integerAvg

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns IntegerAverageAggregator

    an aggregator that calculates the average of the input values. Does NOT accept null input values. Accepts only Integer input values (primitive and boxed). Aggregation result type is number.

integerSum

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns IntegerSumAggregator

    an aggregator that calculates the sum of the input values. Does NOT accept null input values. Accepts only Integer input values (primitive and boxed). Aggregation result type is {Long}.

longAvg

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns LongAverageAggregator

    an aggregator that calculates the average of the input values. Does NOT accept null input values. Accepts only Long input values (primitive and boxed). Aggregation result type is number.

longSum

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns LongSumAggregator

    an aggregator that calculates the sum of the input values. Does NOT accept null input values. Accepts only Long input values (primitive and boxed). Aggregation result type is {Long}.

max

  • Type parameters

    • R

      type of the input object.

    Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns MaxAggregator<R>

    an aggregator that calculates the max of the input values. Accepts null input values. Aggregation result type is

min

  • Type parameters

    • R

      type of the input object.

    Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns MinAggregator<R>

    an aggregator that calculates the min of the input values. Accepts null input values. Aggregation result type is

numberAvg

  • Parameters

    • Optional attributePath: string

      extracts values from this path if given

    Returns NumberAverageAggregator

    an aggregator that calculates the average of the input values. Does NOT accept null input values. Accepts generic Number input values. Aggregation result type is Double.

Generated using TypeDoc