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

• Omit<SubscribeChangesOptions<T>, "includeInitialState">

T extends object = Record<string, unknown>

optional limit: number;

optional limit: number;

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

Internal

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

SubscribeChangesOptions.limit

optional onLoadSubsetResult: (result) => void;

optional onLoadSubsetResult: (result) => void;

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

Internal

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

true | Promise<void>

void

Omit.onLoadSubsetResult

Omit.onLoadSubsetResult

optional onStatusChange: (event) => void;

optional onStatusChange: (event) => void;

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

Internal

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

SubscriptionStatusChangeEvent

void

Omit.onStatusChange

Omit.onStatusChange

optional orderBy: OrderBy;

optional orderBy: OrderBy;

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

Internal

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

SubscribeChangesOptions.orderBy

optional where: (row) => any;

optional where: (row) => any;

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

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.

SingleRowRefProxy<T>

any

import { eq } from "@tanstack/db"

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

import { eq } from "@tanstack/db"

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

Omit.where

Omit.where

optional whereExpression: BasicExpression<boolean>;

optional whereExpression: BasicExpression<boolean>;

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

Pre-compiled expression for filtering changes

SubscribeChangesOptions.whereExpression