Class ZAggregateBuilder<T>

A builder for the aggregate model.

Type Parameters

T = any

Index

Constructors

Methods

build count id value

Constructors

constructor

new ZAggregateBuilder<T = any>(): ZAggregateBuilder<T>
Type Parameters
- T = any
Returns ZAggregateBuilder<T>

Methods

build

build(): IZAggregate<T>
Builds the aggregate.

Returns IZAggregate<T>
The constructed aggregate value.
- Defined in packages/helpful-query/src/aggregate/aggregate.mts:75

count

count(value: number): ZAggregateBuilder<number>
Creates a count aggregate.

The id of the aggregate will be 'count'
Parameters
- value: number
  The count value.
Returns ZAggregateBuilder<number>
A new aggregate builder that is of type number.
- Defined in packages/helpful-query/src/aggregate/aggregate.mts:65

id

id(value: string): ZAggregateBuilder<T>
Sets the id of the aggregate.
Parameters
- value: string
  The id to set.
Returns ZAggregateBuilder<T>
This object.
- Defined in packages/helpful-query/src/aggregate/aggregate.mts:34

value

value<V>(value: V): ZAggregateBuilder<V>
Sets the value of the aggregate.
Type Parameters
- V
Parameters
- value: V
  The value to set.
Returns ZAggregateBuilder<V>
A new aggregate builder that is of type V.
- Defined in packages/helpful-query/src/aggregate/aggregate.mts:48