본문으로 건너뛰기

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

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

타입 매개변수​

T​

T extends object = Record<string, unknown>

TKey​

TKey extends string | number = string | number

속성​

exportSyncMeta()?​

optional exportSyncMeta: () => unknown;

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

수화/영속성이 동기화를 재개할 수 있도록 어댑터별 메타데이터를 내보냅니다. 페이로드 형태는 어댑터가 관리합니다.

반환값​

unknown

getSyncMetadata()?​

optional getSyncMetadata: () => Record<string, unknown>;

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

삽입 작업의 동기화 메타데이터를 가져옵니다

반환값​

Record&lt;string, unknown>

관계 정보를 포함하는 레코드입니다

importSyncMeta()?​

optional importSyncMeta: (meta) => void;

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

exportSyncMeta에서 생성된 어댑터별 메타데이터를 가져옵니다.

매개변수​

meta​

unknown

반환값​

void

mergeSyncMeta()?​

optional mergeSyncMeta: (current, incoming) => unknown;

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

수화 중 두 어댑터별 메타데이터 페이로드를 병합합니다.

매개변수​

current​

unknown

incoming​

unknown

반환값​

unknown

rowUpdateMode?​

optional rowUpdateMode: "full" | "partial";

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

컬렉션에 동기화하는 데 사용되는 행 업데이트 모드입니다.

기본값​

partial

설명​

  • partial: 업데이트에는 행의 변경 사항만 포함됩니다.
  • full: 업데이트에는 전체 행이 포함됩니다.

sync()​

sync: (params) => 
  | void
  | CleanupFn
  | SyncConfigRes;

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

매개변수​

params​
begin​

(options?) => void

새 동기화 트랜잭션을 시작합니다.

컬렉션​

Collection&lt;T, TKey, any, any, any>

커밋​

(signal?) => SyncAppliedReceipt

활성 동기화 트랜잭션을 FIFO 순서로 커밋합니다. 쓰기와 이벤트가 이미 표시되는 경우 true를 반환합니다. 그렇지 않으면 표시된 후 확인되는 영수증을 반환합니다. 컬렉션 정리 또는 선택적 요청 중단으로 트랜잭션이 먼저 포기되면 영수증은 AbortError이라는 이름의 오류와 함께 거부됩니다. 취소 후 게시해서는 안 되는 요청 범위 작업에만 signal을 전달합니다. 애플리케이션 후 중단은 아무런 영향을 주지 않습니다.

markError​

(error?) => void

사용 가능한 스냅샷을 생성하기 전에 초기 동기화가 실패했음을 나타냅니다. 제공된 경우 error은 preload()의 거부 사유로 유지됩니다.

markReady​

() => void

사용 가능한 초기 또는 복구된 스냅샷을 사용할 수 있음을 알립니다.

metadata?​

SyncMetadataApi&lt;TKey>

truncate​

() => void

write​

(message) => void

반환값​

| void | CleanupFn | SyncConfigRes