SubscribeChangesSnapshotOptions

Interface: SubscribeChangesSnapshotOptions<T>

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

Extends

Type Parameters

T

T extends object = Record<string, unknown>

Properties

limit?

ts
optional limit: number;

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


onStatusChange()?

ts
optional onStatusChange: (event) => void;

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

Internal

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

Parameters

event

SubscriptionStatusChangeEvent

Returns

void

Inherited from

ts
Omit.onStatusChange

orderBy?

ts
optional orderBy: OrderBy;

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


where()?

ts
optional where: (row) => any;

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

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<T>

Returns

any

Example

ts
import { eq } from "@tanstack/db"

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

Inherited from

ts
Omit.where

whereExpression?

ts
optional whereExpression: BasicExpression<boolean>;

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

Pre-compiled expression for filtering changes

Inherited from

SubscribeChangesOptions.whereExpression