Class SyncClient

constructor

• new SyncClient(opts: SyncClientOptions): SyncClient

  Parameters

  • opts: SyncClientOptions

  Returns SyncClient

ReadonlybaseUrl

Readonlyopts

claimPairingCode

• claimPairingCode(code: string, deviceName: string): Promise<PairingClaim>

  Exchanges a pairing code for a device token (no token needed; the code is the credential).

  Parameters

  • code: string
  • deviceName: string

  Returns Promise<PairingClaim>

createPairingCode

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

  A pairing code another device of the same user can claim (needs a device token).

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

database

• database(id: string): BlobHandle

  Parameters

  • id: string

  Returns BlobHandle

health

• health(): Promise<unknown>

  Returns Promise<unknown>

listDatabases

• listDatabases(): Promise<BlobMeta[]>

  Returns Promise<BlobMeta[]>

listVaults

• listVaults(): Promise<BlobMeta[]>

  Returns Promise<BlobMeta[]>

request

• request(
      path: string,
      init?: {
          body?: Uint8Array<ArrayBufferLike>;
          headers?: Record<string, string>;
          method?: string;
          signal?: AbortSignal;
      },
  ): Promise<Response>

  Sends with the bearer token; on 401 with a refreshable source, retries once with a fresh token.

  Parameters

  • path: string
  • init: {
        body?: Uint8Array<ArrayBufferLike>;
        headers?: Record<string, string>;
        method?: string;
        signal?: AbortSignal;
    } = {}

  Returns Promise<Response>

token

• token(force?: boolean): Promise<string | null>

  Parameters

  • force: boolean = false

  Returns Promise<string | null>

url

• url(path: string): string

  Parameters

  • path: string

  Returns string

vault

• vault(id: string): BlobHandle

  Parameters

  • id: string

  Returns BlobHandle

StaticetagFor

• etagFor(data: Uint8Array): Promise<string>

  Same as Qt's SyncServerClient::etagFor: the quoted hex SHA-256 of the data.

  Parameters

  • data: Uint8Array

  Returns Promise<string>

StaticisPairingCode

• isPairingCode(text: string): boolean

  Parameters

  • text: string

  Returns boolean

StaticselfHosted

• selfHosted(
      serverUrl: string,
      opts?: Omit<SyncClientOptions, "baseUrl">,
  ): SyncClient

  For a self-hosted server URL like https://sync.example.org (adds /api/v1, as Qt does).

  Parameters

  • serverUrl: string
  • opts: Omit<SyncClientOptions, "baseUrl"> = {}

  Returns SyncClient