LiveRowsSubscription

Defined in: packages/client/src/index.ts:1321

A handle to a live-rows subscription: the initial ordered snapshot plus an idempotent unsubscribe.

Type Parameters

TRow

TRow

Properties

hydrated?

optional hydrated?: Promise<void>

Defined in: packages/client/src/index.ts:1340

Present when the query reads ANY consistency group (eager OR lazy) that was NOT YET caught up at subscribe time: resolves once every such group has completed its initial catch-up AND this subscription has already delivered rows reflecting it (the seam refreshes the live query after catch-up, then resolves — rows-before-signal is guaranteed, so flipping a UI out of its loading state on this promise can never flash a false “empty”). Absent when every referenced group is already ready at subscribe time (the steady-state fast path — no extra refresh) or sync is disabled. Offline note: stays pending until the catch-up truly completes — gate empty-state COPY on it, not data access (rows flow regardless).

---

initialRows

initialRows: TRow[]

Defined in: packages/client/src/index.ts:1322

---

lazyTables?

optional lazyTables?: readonly string[]

Defined in: packages/client/src/index.ts:1329

The lazy relations the query reads (the guard’s scan) — the relations held out of the eager boot set. Activation (stream start) completed before the subscription registered. Informational only: hydrated — not this — reflects catch-up completion, and it now spans eager groups too.

---

unsubscribe

unsubscribe: () => void

Defined in: packages/client/src/index.ts:1323

Returns

void