Replicache JS SDK

Getting Started

Eventually you will be able to npm install but until then...

Prerequisites

NodeJS/NPM
Go binary - https://golang.org/dl/

Replicache JS SDK is written in TypeScript. Run npm run build to generate the JS source code (JS source is outputted in out/). By default we generate browser compatible JS but you can also build CommonJS modules by running npm run build:cjs. let us know what your needs are.

Build the Replicache Client test server binary

Run tool/build.sh which downloads the source code for https://github.com/rocicorp/replicache-client and builds the build/replicache-client/test_server binary.

Run the binary

The Replicache Client test server binary was developed as a quick way to test the Replicache Client API. Eventually we will use a WASM version or have Electron/NodeJS start the binary automatically. But for now we need to manually start it.

build/replicache-client/test_server --no-fake-time

This starts an HTTP server on port 7002 (by default, use --port to change.)

We need to use the --no-fake-time flag for now or all the timestamps will be using a fake time.

Including the JS

By default we only compile the TS to an ES module.

import Replicache, {REPMHTTPInvoker} from './out/mod.js';

To use Replicache you currently have to tell it how to invoke the Replicache Client API Module (REPM).

const diffServerURL = 'https://serve.replicache.dev/pull';
const repmInvoker = new REPMHTTPInvoker('http://localhost:7002');
const repmInvoke = repmInvoker.invoke;
const replicache = new Replicache({
  diffServerURL,
  repmInvoke,
});
await replicache.query(async tx => {
  console.log(await tx.get('/hello'));
});

Replicache