js-bao-wss-client

---

js-bao-wss-client / QueryDefinition

Interface: QueryDefinition

A query operation definition. Keys: filter, sort, limit, projection, include, cache.

Properties

cache?

optional cache?: Record<string, any>

Opt-in result-cache configuration; query definitions only.

---

filter

filter: OperationFilter

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

---

include?

optional include?: Record<string, any>

Related records to include in the result.

---

limit?

optional limit?: number

Maximum records to return (server caps at 1000).

---

projection?

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

Field projection: an include map ({ field: 1 }) or an exclude map ({ field: 0 }). The server's validateProjectionAndSort accepts only a plain object whose values are exactly 0 or 1 — arrays and boolean values are rejected with a 400.

---

sort?

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

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