rxdb
Version:
A local-first realtime NoSQL Database for JavaScript applications - https://rxdb.info/
102 lines (101 loc) • 5.46 kB
TypeScript
/**
* This plugin contains the primitives to create
* a RxDB client-server replication.
* It is used in the other replication plugins
* but also can be used as standalone with a custom replication handler.
*/
import { BehaviorSubject, Observable, Subject, Subscription } from 'rxjs';
import type { ReplicationOptions, ReplicationPullOptions, ReplicationPushOptions, RxCollection, RxDocumentData, RxError, RxDocument, RxJsonSchema, RxReplicationConflict, RxReplicationPullStreamItem, RxStorageInstance, RxStorageInstanceReplicationState, RxStorageReplicationMeta, RxTypeError, WithDeleted } from '../../types/index.js';
export declare const REPLICATION_STATE_BY_COLLECTION: WeakMap<RxCollection, RxReplicationState<any, any>[]>;
export declare class RxReplicationState<RxDocType, CheckpointType> {
/**
* The identifier, used to flag revisions
* and to identify which documents state came from the remote.
*/
readonly replicationIdentifier: string;
readonly collection: RxCollection<RxDocType, unknown, unknown, unknown>;
readonly deletedField: string;
readonly pull?: ReplicationPullOptions<RxDocType, CheckpointType> | undefined;
readonly push?: ReplicationPushOptions<RxDocType> | undefined;
readonly live?: boolean | undefined;
retryTime?: number | undefined;
autoStart?: boolean | undefined;
toggleOnDocumentVisible?: boolean | undefined;
readonly subs: Subscription[];
readonly subjects: {
received: Subject<RxDocumentData<RxDocType>>;
sent: Subject<WithDeleted<RxDocType>>;
error: Subject<RxError | RxTypeError>;
canceled: BehaviorSubject<boolean>;
active: BehaviorSubject<boolean>;
conflict: Subject<RxReplicationConflict<RxDocType>>;
};
readonly received$: Observable<RxDocumentData<RxDocType>>;
readonly sent$: Observable<WithDeleted<RxDocType>>;
readonly error$: Observable<RxError | RxTypeError>;
readonly canceled$: Observable<any>;
readonly active$: Observable<boolean>;
readonly conflict$: Observable<RxReplicationConflict<RxDocType>>;
wasStarted: boolean;
readonly metaInfoPromise: Promise<{
collectionName: string;
schema: RxJsonSchema<RxDocumentData<RxStorageReplicationMeta<RxDocType, any>>>;
}>;
startPromise: Promise<void>;
/**
* start/pause/cancel/remove must never run
* in parallel to avoid a wide range of bugs.
*/
startQueue: Promise<any>;
onCancel: (() => void)[];
constructor(
/**
* The identifier, used to flag revisions
* and to identify which documents state came from the remote.
*/
replicationIdentifier: string, collection: RxCollection<RxDocType, unknown, unknown, unknown>, deletedField: string, pull?: ReplicationPullOptions<RxDocType, CheckpointType> | undefined, push?: ReplicationPushOptions<RxDocType> | undefined, live?: boolean | undefined, retryTime?: number | undefined, autoStart?: boolean | undefined, toggleOnDocumentVisible?: boolean | undefined);
private callOnStart;
internalReplicationState?: RxStorageInstanceReplicationState<RxDocType>;
metaInstance?: RxStorageInstance<RxStorageReplicationMeta<RxDocType, CheckpointType>, any, {}, any>;
remoteEvents$: Subject<RxReplicationPullStreamItem<RxDocType, CheckpointType>>;
start(): Promise<void>;
_start(): Promise<void>;
pause(): Promise<any>;
isPaused(): boolean;
isStopped(): boolean;
isStoppedOrPaused(): boolean;
awaitInitialReplication(): Promise<void>;
/**
* Returns a promise that resolves when:
* - All local data is replicated with the remote
* - No replication cycle is running or in retry-state
*
* WARNING: Using this function directly in a multi-tab browser application
* is dangerous because only the leading instance will ever be replicated,
* so this promise will not resolve in the other tabs.
* For multi-tab support you should set and observe a flag in a local document.
*/
awaitInSync(): Promise<true>;
/**
* Returns a promise that resolves when the given RxDocument instance
* was successfully pushed to the server.
*
* It resolves either when the document is emitted on sent$ (the live
* push case) or, for documents that were already pushed before this was
* called, when the assumed master state in the replication meta instance
* already contains the given document state.
*
* If the document was overwritten by a newer local write before it could
* be pushed, the promise resolves as soon as any later state of the
* document has been pushed, because that also proves the given state
* reached the server.
*/
awaitDocumentPushed(doc: RxDocument<RxDocType>): Promise<void>;
reSync(): void;
emitEvent(ev: RxReplicationPullStreamItem<RxDocType, CheckpointType>): void;
cancel(): Promise<void>;
_cancel(doNotClose?: boolean): Promise<any>;
remove(): Promise<any>;
}
export declare function replicateRxCollection<RxDocType, CheckpointType>({ replicationIdentifier, collection, deletedField, pull, push, live, retryTime, waitForLeadership, autoStart, toggleOnDocumentVisible }: ReplicationOptions<RxDocType, CheckpointType>): RxReplicationState<RxDocType, CheckpointType>;
export declare function startReplicationOnLeaderShip(waitForLeadership: boolean, replicationState: RxReplicationState<any, any>): Promise<void>;