Module aggregation/Aggregators

Index

Functions

Functions

count

count(attributePath?: string): Aggregator<Long>

- Defined in src/aggregation/Aggregators.ts:40
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<Long>

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

distinct

distinct<R>(attributePath?: string): Aggregator<Set<R>>

- Defined in src/aggregation/Aggregators.ts:172
Type parameters
- R
  
  type of the return object.
Parameters
- Optional attributePath: string
  
  extracts values from this path if given.
Returns Aggregator<Set<R>>

an aggregator that calculates the distinct set of input values. Accepts null input values. Aggregation result type is a Set of R.

doubleAvg

doubleAvg(attributePath?: string): Aggregator<number>

- Defined in src/aggregation/Aggregators.ts:51
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<number>

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

doubleSum(attributePath?: string): Aggregator<number>

- Defined in src/aggregation/Aggregators.ts:62
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<number>

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 number.

fixedPointSum

fixedPointSum(attributePath?: string): Aggregator<Long>

- Defined in src/aggregation/Aggregators.ts:84
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<Long>

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

floatingPointSum(attributePath?: string): Aggregator<number>

- Defined in src/aggregation/Aggregators.ts:95
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<number>

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

integerAvg(attributePath?: string): Aggregator<number>

- Defined in src/aggregation/Aggregators.ts:128
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<number>

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

integerSum(attributePath?: string): Aggregator<Long>

- Defined in src/aggregation/Aggregators.ts:139
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<Long>

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

longAvg(attributePath?: string): Aggregator<number>

- Defined in src/aggregation/Aggregators.ts:150
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<number>

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

longSum(attributePath?: string): Aggregator<Long>

- Defined in src/aggregation/Aggregators.ts:161
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<Long>

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

max<R>(attributePath?: string): Aggregator<R>

- Defined in src/aggregation/Aggregators.ts:106
Type parameters
- R
  
  type of the input object.
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<R>

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

min

min<R>(attributePath?: string): Aggregator<R>

- Defined in src/aggregation/Aggregators.ts:117
Type parameters
- R
  
  type of the input object.
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<R>

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

numberAvg

numberAvg(attributePath?: string): Aggregator<number>

- Defined in src/aggregation/Aggregators.ts:73
Parameters
- Optional attributePath: string
  
  extracts values from this path if given
Returns Aggregator<number>

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 number.

Generated using TypeDoc