Interface: XQueryAggregate

Defined in: lang-xquery/src/language/language.ts:91

XQuery-specific extension of AggregateFn that can suppress automatic atomization.

Extends

• AggregateFn

Properties

includeNulls?

optional includeNulls?: boolean

Defined in: core/dist/extension.d.ts:39

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

Inherited from

AggregateFn.includeNulls

---

init

init: () => any

Defined in: core/dist/extension.d.ts:29

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

Returns

any

Inherited from

AggregateFn.init

---

name

name: string

Defined in: core/dist/extension.d.ts:25

Unique name used to look up this aggregate function.

Inherited from

AggregateFn.name

---

result

result: (state) => any

Defined in: core/dist/extension.d.ts:37

Receive the current state, should extract the aggregation result.

Parameters

Parameter	Type
state	any

Returns

any

Inherited from

AggregateFn.result

---

schema?

optional schema?: string | symbol

Defined in: core/dist/extension.d.ts:27

Schema (name prefix) of the function.

Inherited from

AggregateFn.schema

---

skipAtomization?

optional skipAtomization?: boolean

Defined in: lang-xquery/src/language/language.ts:93

When true, values are not atomized before being passed to the aggregate steps.

---

step

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

Defined in: core/dist/extension.d.ts:31

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

Parameters

Parameter	Type
state	any
...vals	any[]

Returns

any

Inherited from

AggregateFn.step

---

stepInverse?

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

Defined in: core/dist/extension.d.ts:35

Optional inverse step function for speeding up window functions.

Parameters

Parameter	Type
state	any
...vals	any[]

Returns

any

Inherited from

AggregateFn.stepInverse