FilterOptions

FilterOptions = object

Filters accepted by client.thing.query and related list operations.

Properties

shape?

optional shape?: string

Filter to records of this shape name (for example Player).

---

kind?

optional kind?: (typeof COMMIT_OPERATION_KINDS)[number]

Filter to records of this kind: shape, thing, assertion, or collection.

---

about?

optional about?: string

Filter assertions whose about target wref matches the supplied value.

---

match?

optional match?: string

Glob pattern matched against record names (for example Player/*).

---

includeRetracted?

optional includeRetracted?: boolean

Include retracted versions in the result set.

---

limit?

optional limit?: number

Maximum records returned per page.

---

cursor?

optional cursor?: string

Pagination cursor returned by the prior call.

---

componentRef?

optional componentRef?: string

Filter to records attributed to this installed component’s Org/Name ref.

---

excludeComponents?

optional excludeComponents?: boolean

Exclude records attributed to any component.

---

excludeInfraShapes?

optional excludeInfraShapes?: boolean

Exclude internal infrastructure shapes from the result set.

---

resolveCollections?

optional resolveCollections?: boolean

Expand collection targets to their members in the result.

---

role?

optional role?: "from" | "to" | "ends"

Keep collection-resolved assertions where the target occupies this role.

---

where?

optional where?: WherePredicate[]

Field-value WHERE predicates (ANDed). Each predicate must target a pinned/ready field for typed-index routing; unavailable or unindexable fields return a machine-readable field-index error. Up to 8 predicates per call.

---

sinceRepoSeq?

optional sinceRepoSeq?: number

Strict lower repository sequence for an incremental scan; -1 seeds a complete snapshot.