commit | 9e412e34d400867e890ce1e11d4642e5e0d4a7f6 | [log] [tgz] |
---|---|---|
author | Ali Ghassemi <aghassemi@google.com> | Tue Sep 08 15:53:59 2015 -0700 |
committer | Ali Ghassemi <aghassemi@google.com> | Tue Sep 08 15:53:59 2015 -0700 |
tree | 89beacc21e308f504f95d0b1f92926ba582881a1 | |
parent | 6353d6ae1a327eec174651f52719849686c6c5f0 [diff] |
javascript/syncbase: Allowing methods that take RowRange/PrefixRange to also accept strings. When a string is used, it is interpreted as 'prefix'. scan and deleteRange accept string in addition to RowRange. When a string is used, it is assumed to be a prefix rather than a single row key. This is a reasonable assumption since deleteRange has the sister method delete(string key) that can be used for deleting single rows and scanning for a single row is equivalent to doing a get. Now we are also removing PrefixRange completely since prefix is now just a string for scan, deleteRange and setPermission. PrefixPermission also now has the prefix property as string instead of PrefixRange. Closes https://github.com/vanadium/issues/issues/677 Change-Id: If1c611ef6f5d0bc88ad8c2b45df2784d32ecf276
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.
Since Vanadium is currently hosted in private repositories, you would need to [setup SSH keys for Github] (https://help.github.com/articles/generating-ssh-keys/) first and then use npm to install directly from GitHub:
npm install --save git+ssh://git@github.com:vanadium/js.syncbase.git
currently vanadium.js
needs to be installed manually as well:
npm install --save git+ssh://git@github.com:vanadium/js.git
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, sycnbase expects that the vanadium extension will be installed.
Bugs and feature requests should be filed in the Vanadium issue tracker.
GNU Make is used to build and test Syncbase.
Build everything:
make
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