Defined in: packages/db/src/types.ts:972
Extends#
Omit<SubscribeChangesOptions<T,TKey>,"includeInitialState">
Type Parameters#
T#
T extends object = Record<string, unknown>
TKey#
TKey extends string | number = string | number
Properties#
limit?#
optional limit: number;
Defined in: packages/db/src/types.ts:977
Internal
Optional limit to include in loadSubset for query-specific cache keys.
Overrides#
onLoadSubsetError()?#
optional onLoadSubsetError: (event) => void;
Defined in: packages/db/src/types.ts:964
Internal
Receives subset-load failures scoped to this subscription.
Parameters#
event#
SubscriptionLoadSubsetErrorEvent
Returns#
void
Inherited from#
Omit.onLoadSubsetError
onLoadSubsetResult()?#
optional onLoadSubsetResult: (result) => void;
Defined in: packages/db/src/types.ts:962
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#
Returns#
void
Inherited from#
Omit.onLoadSubsetResult
onStatusChange()?#
optional onStatusChange: (event) => void;
Defined in: packages/db/src/types.ts:946
Internal
Listener for subscription status changes. Registered BEFORE any snapshot is requested, ensuring no status transitions are missed.
Parameters#
event#
Returns#
void
Inherited from#
Omit.onStatusChange
orderBy?#
optional orderBy: OrderBy;
Defined in: packages/db/src/types.ts:976
Internal
Optional orderBy to include in loadSubset for query-specific cache keys.
Overrides#
SubscribeChangesOptions.orderBy
truncateReplayPublication?#
optional truncateReplayPublication: object;
Defined in: packages/db/src/types.ts:966
Internal
Lets a live-query graph retain its last publication during replay.
start()#
readonly start: () => void;
Returns#
void
succeed()#
readonly succeed: () => void;
Returns#
void
Inherited from#
Omit.truncateReplayPublication
where()?#
optional where: (row) => any;
Defined in: packages/db/src/types.ts:938
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>>
Returns#
any
Example#
import { eq } from "@tanstack/db"
collection.subscribeChanges(callback, {
where: (row) => eq(row.status, "active")
})
Inherited from#
Omit.where
whereExpression?#
optional whereExpression: BasicExpression<boolean>;
Defined in: packages/db/src/types.ts:940
Pre-compiled expression for filtering changes