Documentation / @super-line/client / LiveRowSet

Interface: LiveRowSet<Row>

Defined in: index.ts:172

A live view of the rows matching one subscription — the raw, non-optimistic sync primitive beneath the TanStack DB adapter. The initial snapshot arrives via ready; thereafter every matching change streams as a RowSetEvent. Rows leaving the filter (an update that no longer matches) arrive as delete events. Auto-resubscribes and re-diffs on reconnect. Optimism belongs to the layer above (TanStack), not here.

Type Parameters

Row

Row = unknown

Properties

ready

readonly ready: Promise<void>

Defined in: index.ts:178

Resolves once the initial snapshot has been applied.

Methods

close()

close(): void

Defined in: index.ts:180

Stop the subscription and tell the server to drop it.

Returns

void

---

rows()

rows(): Row[]

Defined in: index.ts:174

Current matching rows, ordered + limited per the subscription query (stable reference between changes).

Returns

Row[]

---

subscribe()

subscribe(cb): () => void

Defined in: index.ts:176

Subscribe to per-row changes. A () => void consumer (e.g. useSyncExternalStore) may ignore the event. Returns an unsub.

Parameters

cb

(ev) => void

Returns

() => void