@serenity-is/corelib / IAggregatorConstructor

Interface: IAggregatorConstructor

Defined in: src/slick/aggregatortyperegistry.ts:7

Constructor interface for aggregator classes.

Constructors

Constructor

new IAggregatorConstructor(field, ...args): IAggregator

Defined in: src/slick/aggregatortyperegistry.ts:9

Creates a new aggregator instance.

Parameters

field

string

The field to aggregate.

args

...any[]

Returns

IAggregator

Properties

aggregateKey

aggregateKey: string

Defined in: src/slick/aggregatortyperegistry.ts:14

A unique key for the aggregator (like 'sum', 'avg', etc.). This is also used in the totals object as a property key to store the results of this aggregator.

---

displayName?

optional displayName: string

Defined in: src/slick/aggregatortyperegistry.ts:18

A user-friendly display name for the aggregator (like "Sum", "Average", etc.)

---

summaryType?

optional summaryType: SummaryType

Defined in: src/slick/aggregatortyperegistry.ts:23

Corresponding SummaryType enum value (like SummaryType.Sum, SummaryType.Avg, etc.), if any.