RefsOptions
RefsOptions =
object
Options for client.thing.refs — wref-field reverse and forward lookups.
Inbound pages may be empty or underfilled after authorization filtering
while still carrying nextCursor; continue until the cursor is absent.
https://docs.warmhub.ai/sdk/typescript/read-semantics/#reference-queries
Properties
Section titled “Properties”direction?
Section titled “direction?”
optionaldirection?:"inbound"|"outbound"
inbound finds records whose wref fields point at the target; outbound finds records the target points to. Defaults to inbound.
fieldPath?
Section titled “fieldPath?”
optionalfieldPath?:string
Narrow an inbound search to a specific wref field path on the source shape.
binding?
Section titled “binding?”
optionalbinding?:"identity"|"versioned"
Keep only edges written under one binding mode: identity edges follow
the target Thing, versioned edges pin one version. Each returned item
also reports its own binding.
limit?
Section titled “limit?”
optionallimit?:number
Maximum references returned per page.
cursor?
Section titled “cursor?”
optionalcursor?:string
Pagination cursor returned by the prior call.