ws-client

@vlcn.io/ws-client

A WebSocket client to do streaming database sync. Meant to be paired with the @vlcn.io/ws-server package or any server that speaks the same protocol.

Setup is pretty trivial as the React bindings support websocket sync. The vlcn vite starter uses WebSocket sync as well.

Setup

Create a Sync Worker

The sync worker file will be loaded and run in its own worker thread. The config will only change when moving between platforms (e.g., React Native vs Web vs Tauri vs Electron).

For web, the config looks like:

import { Config, defaultConfig } from "@vlcn.io/ws-client";
import { start } from "@vlcn.io/ws-client/worker.js";
// Interface to WASM sqlite
import { createDbProvider } from "@vlcn.io/ws-browserdb";

export const config: Config = {
  dbProvider: createDbProvider(),
  transportProvider: defaultConfig.transportProvider,
};

start(config);

Put that code in its own file such as sync-worker.ts.

Instantiate the SyncWorker

Somewhere in the bootstrapping of your application, create an instance of your worker. You should only do this once for your application. The sync worker can sync any number of databases you'd like so there's no need to create many sync workers.

The sync worker is also smart enough to coordinate between tabs and other workers. In other words, if many tabs are open on the same page and they all start the same worker, only one will actively sync a given database at a time.

import SyncWorker from "./sync-worker.js?worker";
const worker = new SyncWorker();

See App.tsx in the Vite starter.

Kick Off Sync

If you're using the React bindings this is pretty simple. Just call the useSync hook:

useSync({
  dbname,
  endpoint: `ws://host/sync`,
  room: dbname,
  worker,
});

See App.tsx in the Vite starter.