Skip to content

js-bao-wss-client


js-bao-wss-client / PipelineAggregateStep

Interface: PipelineAggregateStep ​

An aggregate step inside a pipeline definition's steps array. Keys: name, type, modelName, groupBy, operations, filter, limit, sort. The step's sort is the aggregate { field, direction } shape, not the query field→direction map.

Properties ​

filter? ​

optional filter?: OperationFilter


groupBy ​

groupBy: string | AggregateGroupByEntry[]


limit? ​

optional limit?: number


modelName ​

modelName: string


name ​

name: string

Unique step name (referenced by later steps as $steps.<name>).


operations ​

operations: string | AggregateOperation[]


sort? ​

optional sort?: object

direction ​

direction: -1 | 1

field ​

field: string


type ​

type: "aggregate"

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30