Clone this repo:


  1. 50fa7a1 TBR: js.syncbase: Make all versions 'v23-0.1'. by Nicolas Lacasse · 8 years ago master
  2. 98fd386 TBR: Use "node npm" rather than calling "npm" directly. by Nicolas Lacasse · 8 years ago
  3. c5d6c41 js/syncbase: Make RunInBatch work for readonly batches. by Ivan Pilat · 8 years ago
  4. 4349d15 syncbase/exec: Expose support for parameterized queries. by Ivan Pilat · 8 years ago
  5. 107145c syncbase/watch: Return initial state for empty ResumeMarker. by Ivan Pilat · 8 years ago

Syncbase JavaScript Client

This repository defines the JavaScript API for Syncbase, a structured store that supports peer-to-peer synchronization.

The client APIs defined here work both in Node.js and the browser.


npm install --save vanadium/js.syncbase


Documentation for this API is [TODO(aghassemi)](LINK TO JS DOCUMENTATION)

Tutorials can be found at [TODO(aghassemi)](LINK TO JS TUTORIAL FOR SYNCBASE)

The entry point to the API is through a module called syncbase, everything else is considered private and should not be accessed by the users of the API.

When using Browserify or Node.js users can gain access to the API with:

var syncbase = require("syncbase");

When run in a browser, syncbase expects that the vanadium extension will be installed.

Bugs and feature requests

Bugs and feature requests should be filed in the Vanadium issue tracker.

Building and testing

GNU Make is used to build and test Syncbase.

Build everything:


Test everything:

make test

Run a specific test suite:

make test-integration
make test-integration-node
make test-integration-browser

Remove all build and testing artifacts:

make clean