Class SelfHostedSync

constructor

• new SelfHostedSync(
      serverUrl: string,
      deviceToken: string,
      opts?: SelfHostedOptions,
  ): SelfHostedSync

  Parameters

  • serverUrl: string
  • deviceToken: string
  • opts: SelfHostedOptions = {}

  Returns SelfHostedSync

Readonlyclient

ReadonlydeviceToken

ReadonlyserverUrl

createPairingCode

• createPairingCode(): Promise<{ code: string; expiresAt: string }>

  Returns Promise<{ code: string; expiresAt: string }>

events

• events(opts: EventStreamOptions): EventStream

  Legacy event: database stream.

  Parameters

  • opts: EventStreamOptions

  Returns EventStream

health

• health(): Promise<unknown>

  Returns Promise<unknown>

listDatabases

• listDatabases(): Promise<BlobMeta[]>

  Returns Promise<BlobMeta[]>

syncDatabase

• syncDatabase(
      databaseId: string,
      p: Omit<SyncOptions, "blob">,
  ): Promise<SyncResult>

  Syncs a local database with databases/<databaseId>; keeps the sync state in storage when given.

  Parameters

  • databaseId: string
  • p: Omit<SyncOptions, "blob">

  Returns Promise<SyncResult>

Staticpair

• pair(
      serverUrl: string,
      code: string,
      deviceName: string,
      opts?: SelfHostedOptions,
  ): Promise<SelfHostedSync>

  Claims a pairing code ("ABCD-EFGH") for a device token and stores it.

  Parameters

  • serverUrl: string
  • code: string
  • deviceName: string
  • opts: SelfHostedOptions = {}

  Returns Promise<SelfHostedSync>

Staticrestore

• restore(
      serverUrl: string,
      opts: SelfHostedOptions & { storage: KeyValueStorage },
  ): Promise<SelfHostedSync | null>

  Restores a paired server from storage, or null.

  Parameters

  • serverUrl: string
  • opts: SelfHostedOptions & { storage: KeyValueStorage }

  Returns Promise<SelfHostedSync | null>