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

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

T extends object = Record<string, unknown>

TKey extends string | number = string | number

optional limit: number;

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

Internal

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

SubscribeChangesOptions.limit

optional onLoadSubsetResult: (result) => void;

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

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

optional onStatusChange: (event) => void;

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

Internal

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

SubscriptionStatusChangeEvent

void

Omit.onStatusChange

optional orderBy: OrderBy;

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

Internal

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

SubscribeChangesOptions.orderBy

optional where: (row) => any;

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

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<WithVirtualProps<T, TKey>>

any

import { eq } from "@tanstack/db"

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

Omit.where

optional whereExpression: BasicExpression<boolean>;

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

Pre-compiled expression for filtering changes

SubscribeChangesOptions.whereExpression