SubscribeChangesOptions

Defined in: packages/db/src/types.ts:1072

Options for subscribing to collection changes

Type Parameters#

T#

T extends object = Record<string, unknown>

TKey#

TKey extends string | number = string | number

Properties#

includeInitialState?#

optional includeInitialState: boolean;

Defined in: packages/db/src/types.ts:1077

Whether to include the current state as initial changes

limit?#

optional limit: number;

Defined in: packages/db/src/types.ts:1110

Internal

Optional limit to include in loadSubset for query-specific cache keys.

onLoadSubsetError()?#

optional onLoadSubsetError: (event) => void;

Defined in: packages/db/src/types.ts:1118

Internal

Receives subset-load failures scoped to this subscription.

Parameters#

event#

SubscriptionLoadSubsetErrorEvent

Returns#

void

onLoadSubsetResult()?#

optional onLoadSubsetResult: (result) => void;

Defined in: packages/db/src/types.ts:1116

Internal

Callback that receives the loadSubset result (Promise or true) from requestSnapshot. Allows the caller to directly track the loading promise for isReady status.

Parameters#

result#

LoadSubsetRequestResult

Returns#

void

onStatusChange()?#

optional onStatusChange: (event) => void;

Defined in: packages/db/src/types.ts:1100

Internal

Listener for subscription status changes. Registered BEFORE any snapshot is requested, ensuring no status transitions are missed.

Parameters#

event#

SubscriptionStatusChangeEvent

Returns#

void

orderBy?#

optional orderBy: OrderBy;

Defined in: packages/db/src/types.ts:1105

Internal

Optional orderBy to include in loadSubset for query-specific cache keys.

truncateReplayPublication?#

optional truncateReplayPublication: object;

Defined in: packages/db/src/types.ts:1120

Internal

Lets a live-query graph retain its last publication during replay.

start()#

readonly start: () => void;

Returns#

void

succeed()#

readonly succeed: () => void;

Returns#

void

where()?#

optional where: (row) => any;

Defined in: packages/db/src/types.ts:1092

Callback function for filtering changes using a row proxy. The callback receives a proxy object that records property access, allowing you to use query builder functions like eq, gt, etc.

Parameters#

row#

SingleRowRefProxy<WithVirtualProps<T, TKey>, TKey, true>

Returns#

any

Example#

import { eq } from "@tanstack/db"

collection.subscribeChanges(callback, {
  where: (row) => eq(row.status, "active")
})

whereExpression?#

optional whereExpression: BasicExpression<boolean>;

Defined in: packages/db/src/types.ts:1094

Pre-compiled expression for filtering changes