TanStack
Features API Reference

AggregationFnDef

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:63

A context-based aggregation definition and optional grouped-result merge.

Type Parameters

TFeatures

TFeatures extends TableFeatures = any

TData

TData extends RowData = any

TValue

TValue = unknown

TResult

TResult = unknown

Properties

aggregate

ts
aggregate: (context) => TResult;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:70

Computes a result directly from the selected rows.

Parameters

context

AggregationContext<TFeatures, TData, TValue>

Returns

TResult


merge?

ts
optional merge?: (context) => TResult;

Defined in: features/row-aggregation/rowAggregationFeature.types.ts:75

Combines already-computed immediate sub-row results. When omitted, nested grouping falls back to aggregate over the group's selected rows.

Parameters

context

AggregationMergeContext<TFeatures, TData, TValue, TResult>

Returns

TResult