@serenity-is/corelib / Aggregators / Min

Class: Min

Defined in: src/slick/aggregators.ts:128

Minimum of a field.

Implements

• IAggregator

Constructors

Constructor

new Min(field): Min

Defined in: src/slick/aggregators.ts:138

Creates a new minimum aggregator.

Parameters

field

string

The field to aggregate.

Returns

Min

Properties

field

readonly field: string

Defined in: src/slick/aggregators.ts:130

The field to aggregate.

---

min

min: any

Defined in: src/slick/aggregators.ts:132

Current minimum value.

---

aggregateKey

readonly static aggregateKey: "min" = "min"

Defined in: src/slick/aggregators.ts:168

Key used to store/lookup this aggregator in totals.

---

summaryType

readonly static summaryType: Min = SummaryType.Min

Defined in: src/slick/aggregators.ts:166

Summary type for this aggregator.

Accessors

displayName

Get Signature

get static displayName(): string

Defined in: src/slick/aggregators.ts:170

Localized display name for this aggregator.

Returns

string

Methods

accumulate()

accumulate(item): void

Defined in: src/slick/aggregators.ts:148

Accumulates a single item into the aggregator state.

Parameters

item

any

Row item to accumulate; numeric field values are compared against the current minimum.

Returns

void

Implementation of

IAggregator.accumulate

---

init()

init(): void

Defined in: src/slick/aggregators.ts:143

Initializes state before a new group is processed.

Returns

void

Implementation of

IAggregator.init

---

storeResult()

storeResult(groupTotals): void

Defined in: src/slick/aggregators.ts:158

Writes computed totals into the group totals object.

Parameters

groupTotals

any

Totals container to write the computed minimum into, keyed by field name.

Returns

void

Implementation of

IAggregator.storeResult