Class SyncApi

constructor

• new SyncApi(opts): SyncApi

• Parameters

  • opts: {
        blobStore: BlobStore;
        coreManager: CoreManager;
        coreOwnership: CoreOwnership;
        getReplicationStream: (() => ReplicationStream);
        getServerWebsocketUrls: (() => Promise<Iterable<string, any, any>>);
        logger: undefined | Logger;
        makeWebsocket: undefined | ((url: string) => WebSocket);
        roles: Roles;
        throttleMs: undefined | number;
    }

    • blobStore: BlobStore

    • coreManager: CoreManager

    • coreOwnership: CoreOwnership

    • getReplicationStream: (() => ReplicationStream)

      • • (): ReplicationStream

        • Returns ReplicationStream

    • getServerWebsocketUrls: (() => Promise<Iterable<string, any, any>>)

      • • (): Promise<Iterable<string, any, any>>

        • Returns Promise<Iterable<string, any, any>>

    • logger: undefined | Logger

    • makeWebsocket: undefined | ((url: string) => WebSocket)

    • roles: Roles

    • throttleMs: undefined | number

  Returns SyncApi

[kSyncState]

[kHandleDiscoveryKey]

• [kHandleDiscoveryKey](discoveryKey, protomux): void

• Parameters

  • discoveryKey: Buffer
  • protomux: Protomux<NoiseSecretStream<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>>

  Returns void

[kRequestFullStop]

• [kRequestFullStop](): void

• Request a graceful stop to all sync.

  Returns void

[kRescindFullStopRequest]

• [kRescindFullStopRequest](): void

• Rescind any requests for a full stop.

  Returns void

[kWaitForInitialSyncWithPeer]

• [kWaitForInitialSyncWithPeer](deviceId, abortSignal): Promise<void>

• Parameters

  • deviceId: string
  • abortSignal: AbortSignal

  Returns Promise<void>

connectServers

• connectServers(): void

• Returns void

disconnectServers

• disconnectServers(): void

• Returns void

getState

• getState(): State

• Get the current sync state (initial and full). Also emitted via the 'sync-state' event

  Returns State

setAutostopDataSyncTimeout

• setAutostopDataSyncTimeout(autostopDataSyncAfter): void

• Parameters

  • autostopDataSyncAfter: null | number

  Returns void

start

• start(options?): void

• Start syncing data cores.

  If the app is backgrounded and sync has already completed, this will do nothing until the app is foregrounded.

  Parameters

  • Optionaloptions: {
        autostopDataSyncAfter: undefined | null | number;
    } = {}

    • autostopDataSyncAfter: undefined | null | number

      If no data sync happens after this duration in milliseconds, sync will be automatically stopped as if stop was called.

  Returns void

stop

• stop(): void

• Stop syncing data cores.

  Pre-sync cores will continue syncing unless the app is backgrounded.

  Returns void

waitForSync

• waitForSync(type): Promise<void>

• Parameters

  • type: SyncType

  Returns Promise<void>