Skip to content

@serenity-is/corelib / GroupBy

Interface: GroupBy

Defined in: src/base/servicetypes.ts:234

A field the rows a list request matches are grouped by, for the aggregates of each group.

Properties

Descending?

optional Descending: boolean

Defined in: src/base/servicetypes.ts:238

Whether the groups are in descending order of the field.


Field?

optional Field: string

Defined in: src/base/servicetypes.ts:236

The field name.


Interval?

optional Interval: DateGroupInterval

Defined in: src/base/servicetypes.ts:243

The interval the values of a date field are grouped by, e.g. the months. The key of a group is then the start of its interval. It can only be used with a date field, and the rows are not grouped at all otherwise.