Interface: AggregateFn

Defined in: packages/core/src/extension.ts:30

Aggregator used in queries. For example, sum or count.

Extended by

• XQueryAggregate

Properties

includeNulls?

optional includeNulls?: boolean

Defined in: packages/core/src/extension.ts:46

By default, aggregates ignore nulls. Set this to true to include nulls in the operation.

---

init

init: () => any

Defined in: packages/core/src/extension.ts:36

Called before receiving any values, should prepare the aggregator state.

Returns

any

---

name

name: string

Defined in: packages/core/src/extension.ts:32

Unique name used to look up this aggregate function.

---

result

result: (state) => any

Defined in: packages/core/src/extension.ts:44

Receive the current state, should extract the aggregation result.

Parameters

Parameter	Type
state	any

Returns

any

---

schema?

optional schema?: string | symbol

Defined in: packages/core/src/extension.ts:34

Schema (name prefix) of the function.

---

step

step: (state, ...vals) => any

Defined in: packages/core/src/extension.ts:38

Receive the current state and the next value, should return the next state.

Parameters

Parameter	Type
state	any
...vals	any[]

Returns

any

---

stepInverse?

optional stepInverse?: (state, ...vals) => any

Defined in: packages/core/src/extension.ts:42

Optional inverse step function for speeding up window functions.

Parameters

Parameter	Type
state	any
...vals	any[]

Returns

any