Interface used as argument to and available as a readonly property on

export interface DexieCloudOptions {
  // URL to a database created with `npx dexie-cloud create`
  databaseUrl: string;

  // Whether to require authentication or opt-in to it using
  requireAuth?: boolean;

  // Whether to use service worker. Combine with registering your own service
  // worker and import "dexie-cloud-addon/dist/modern/service-worker.min.js" from it.
  tryUseServiceWorker?: boolean;

  // Optional customization of periodic sync.
  // See
  periodicSync?: {
    // The minimum interval time, in milliseconds, at which the service-worker's
    // periodic sync should occur.
    minInterval: number;

  // Disable default login GUI and replace it with your own by
  // subscribing to the `` observable and render its emitted data.
  customLoginGui?: boolean;

  // Array of table names that should be considered local-only and
  // not be synced with Dexie Cloud
  unsyncedTables?: string[];

  // By default Dexie Cloud will suffix the cloud DB ID to your IndexedDB database name
  // in order to ensure that the local database is uniquely tied to the remote one and
  // will use another local database if databaseURL is changed or if dexieCloud addon
  // is not being used anymore.
  // By setting this value to `false`, no suffix will be added to the database name and
  // instead, it will use the exact name that is specified in the Dexie constructor,
  // without a suffix.
  nameSuffix?: boolean;

  // Disable websocket connection - don't listen to remote changes - effectively disabling eager sync from remote to local.
  disableWebSocket?: boolean;

  // Disable eager sync from local to remote
  disableEagerSync?: boolean;

  // Provides a custom way of fetching the JWT tokens. This option
  // can be used when integrating with custom authentication.
  // See
  fetchTokens?: (tokenParams: {
    public_key: string;
    hints?: { userId?: string; email?: string };
  }) => Promise<TokenFinalResponse>;


Table of Contents