본문으로 건너뛰기

인터페이스: SubscribeChangesOptions<T, TKey>

정의 위치: packages/db/src/types.ts:892

컬렉션 변경 사항을 구독하기 위한 옵션입니다.

타입 매개변수​

T​

T 확장 object = Record<string, unknown>

TKey​

TKey 확장 string | number = string | number

속성​

includeInitialState?​

optional includeInitialState: boolean;

정의 위치: packages/db/src/types.ts:897

현재 상태를 초기 변경 사항으로 포함할지 여부입니다.

limit?​

optional limit: number;

정의 위치: packages/db/src/types.ts:930

Internal

쿼리별 캐시 키를 위해 loadSubset에 포함할 선택적 제한입니다.

onLoadSubsetError()?​

optional onLoadSubsetError: (event) => void;

정의 위치: packages/db/src/types.ts:938

Internal

이 구독 범위에 해당하는 부분 집합 로드 실패를 전달합니다.

매개변수​

event​

SubscriptionLoadSubsetErrorEvent

반환값​

void

onLoadSubsetResult()?​

optional onLoadSubsetResult: (result) => void;

정의 위치: packages/db/src/types.ts:936

Internal

requestSnapshot에서 반환된 loadSubset 결과(Promise 또는 true)를 받는 콜백입니다. isReady 상태를 위해 호출자가 로딩 Promise를 직접 추적할 수 있습니다.

매개변수​

결과​

true | Promise<void>

반환값​

void

onStatusChange()?​

optional onStatusChange: (event) => void;

정의 위치: packages/db/src/types.ts:920

Internal

구독 상태 변경을 수신하는 리스너입니다. 모든 스냅샷이 요청되기 전에 등록되어 상태 전환을 놓치지 않도록 합니다.

매개변수​

event​

SubscriptionStatusChangeEvent

반환값​

void

orderBy?​

optional orderBy: OrderBy;

정의 위치: packages/db/src/types.ts:925

Internal

쿼리별 캐시 키를 위해 loadSubset에 포함할 선택적 orderBy입니다.

where()?​

optional where: (row) => any;

정의 위치: packages/db/src/types.ts:912

행 프록시를 사용하여 변경 사항을 필터링하는 콜백 함수입니다. 콜백은 속성 접근을 기록하는 프록시 객체를 받으므로, eq, gt 등의 쿼리 빌더 함수를 사용할 수 있습니다.

매개변수​

row​

SingleRowRefProxy<WithVirtualProps<T, TKey>>

반환값​

any

예제​

import { eq } from "@tanstack/db"

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

whereExpression?​

optional whereExpression: BasicExpression<boolean>;

정의 위치: packages/db/src/types.ts:914

변경 사항을 필터링하기 위한 사전 컴파일된 표현식입니다.