본문으로 건너뛰기

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

정의 위치: packages/db/src/live-query-observer.ts:72

Internal

확정된 라이브 쿼리 Collection(비활성화된 쿼리의 경우 null)를 모든 프레임워크 어댑터에 필요한 공유 수명 주기로 감쌉니다. 처음 구독할 때 동기화를 시작하고, 변경 사항과 상태 전환을 구독하며, 전체 소비자를 위한 안정적인 스냅샷을 노출하고, 세분화된 소비자를 위해 원시 변경 집합을 전달합니다.

입력 확인(쿼리 함수 / 구성 / 컬렉션 / 비활성화)은 프레임워크 반응형이므로 어댑터에서 수행됩니다. 옵저버는 입력이 구체적인 컬렉션으로 확인된 이후의 모든 작업을 소유합니다.

TanStack DB의 공식 프레임워크 어댑터를 위한 불안정한 계약입니다. 아직 공개 확장 지점이 아니며 모든 릴리스에서 변경될 수 있습니다.

타입 매개변수

T

T extends object

TKey

TKey extends string | number

속성

dehydrate()

dehydrate: () => DehydratedLiveQueryResult<T, TKey>;

정의 위치: packages/db/src/live-query-observer.ts:92

소스 컬렉션을 직렬화하지 않고 순서가 지정된 쿼리 결과를 캡처합니다.

반환값

DehydratedLiveQueryResult&lt;T, TKey>


dispose()

dispose: () => void;

정의 위치: packages/db/src/live-query-observer.ts:94

멱등적인 정리입니다.

반환값

void


getError()

getError: () => unknown;

정의 위치: packages/db/src/live-query-observer.ts:90

데이터를 생성하지 않은 경우 이 쿼리의 전송 또는 프리로드 오류입니다.

반환값

unknown


getServerSnapshot()

getServerSnapshot: () => LiveQuerySnapshot<T, TKey>;

정의 위치: packages/db/src/live-query-observer.ts:79

useSyncExternalStore 스타일 어댑터에서 사용하는 안정적인 서버 스냅샷입니다.

반환값

LiveQuerySnapshot&lt;T, TKey>


getSnapshot()

getSnapshot: () => LiveQuerySnapshot<T, TKey>;

정의 위치: packages/db/src/live-query-observer.ts:77

전체 구체화에 사용되는 리비전별 안정적인 스냅샷입니다.

반환값

LiveQuerySnapshot&lt;T, TKey>


preload()

preload: () => Promise<void>;

정의 위치: packages/db/src/live-query-observer.ts:88

컬렉션이 첫 데이터를 로드하면 확인을 완료합니다.

반환값

Promise&lt;void>


subscribe()

subscribe: (listener) => () => void;

정의 위치: packages/db/src/live-query-observer.ts:86

변경 사항을 구독합니다. 리스너는 변경 집합을 받습니다(또는 연결 시 준비된 컬렉션이 내보내는 합성 알림의 경우 undefined를 받습니다). 세분화된 어댑터는 변경 사항을 적용하고, 전체 어댑터는 이를 무시하고 getSnapshot()을 다시 읽을 수 있습니다. 구독 취소 함수를 반환합니다.

매개변수

리스너

LiveQueryObserverListener&lt;T, TKey>

반환값

(): void;
반환값

void