QueryStreamOptions

Options for queryStream. The public surface is deliberately small — the stream’s own definition carries the source set, order, exclusions, projection, and expansion depth; a caller supplies only paging, locale/ctx, and values for the filters the stream declares (an undeclared key is 400 validation_failed).

Extends

• RequestOptions.CurrentSiteOption

Properties

ctx?

optional ctx?: ContextBag

The personalization context, server-resolved (the ReadOptions.ctx semantics).

---

cursor?

optional cursor?: string

Opaque — replay exactly as received; a stream-order change invalidates outstanding cursors (400 invalid_cursor; restart the listing).

---

filters?

optional filters?: Record<string, string | readonly string[]>

Values for the stream’s declared filters, keyed by declared key (sent as filter.<key>=). An array repeats the parameter — OR within the key for string/category filters; a fullText filter takes exactly one value.

---

limit?

optional limit?: number

1–100; the server defaults to 20.

---

locale?

optional locale?: string

BCP-47 code — locale resolution plus the paths locale slot, the listComponents semantics.

---

referencePaths?

optional referencePaths?: boolean

ReadOptions.referencePaths, on each item’s projected content. Item addresses are unconditional on a stream and need no option.

---

signal?

optional signal?: AbortSignal

Inherited from

RequestOptions.signal

---

site?

optional site?: string

Inherited from

CurrentSiteOption.site