Skip to content

js-bao-wss-client


js-bao-wss-client / DocumentListOptions

Type Alias: DocumentListOptions ​

DocumentListOptions = object

Options for me.ownedDocuments() controlling loading strategy (local cache vs network), pagination, tag filtering, and result shape.

Properties ​

cursor? ​

optional cursor?: string | null


forward? ​

optional forward?: boolean


includeRoot? ​

optional includeRoot?: boolean


limit? ​

optional limit?: number


localOnly? ​

optional localOnly?: boolean


refreshFromServer? ​

optional refreshFromServer?: boolean


returnPage? ​

optional returnPage?: boolean


serverTimeoutMs? ​

optional serverTimeoutMs?: number


tag? ​

optional tag?: string | null


waitForLoad? ​

optional waitForLoad?: "local" | "network" | "localIfAvailableElseNetwork"

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