Skip to content

js-bao-wss-client


js-bao-wss-client / PipelineQueryStep

Interface: PipelineQueryStep ​

A query step inside a pipeline definition's steps array. Keys: name, type, modelName, filter, sort, limit, projection, include.

Properties ​

filter ​

filter: OperationFilter

Structured filter object, or a $params/$steps reference. Required.


include? ​

optional include?: Record<string, any>


limit? ​

optional limit?: number


modelName ​

modelName: string


name ​

name: string

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


projection? ​

optional projection?: Record<string, 0 | 1>

Field projection: an include (1) or exclude (0) map. Object only.


sort? ​

optional sort?: Record<string, -1 | 1>

Field → sort direction (1 ascending, -1 descending).


type ​

type: "query"

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