PouchDB Plugin - pouchdb-envoy
A custom replicator for use with Cloudant Envoy. Instead of doing:
var PouchDB = ;var local = "local";localreplicate;
var PouchDB = ;PouchDB;var local = 'local';var remote = '';local;
To push data up to the server, you can do:
npm install npm run build
Your plugin is now located at
dist/pouchdb.pouchdb-envoy.min.js and is ready for distribution.
This will run the tests in Node using LevelDB:
You can also check for 100% code coverage using:
npm run coverage
If you don't like the coverage results, change the values from 100 to something else in
package.json, or add
/*istanbul ignore */ comments.
If you have mocha installed globally you can run single test with:
TEST_DB=local mocha --reporter spec --grep search_phrase
TEST_DB environment variable specifies the database that PouchDB should use (see
In the browser
npm run dev and then point your favorite browser to http://127.0.0.1:8001/test/index.html.
The query param
?grep=mysearch will search for tests matching
Automated browser tests
You can run e.g.
CLIENT=selenium:firefox npm test CLIENT=selenium:phantomjs npm test
This will run the tests automatically and the process will exit with a 0 or a 1 when it's done. Firefox uses IndexedDB, and PhantomJS uses WebSQL.
What to tell your users
Below is some boilerplate you can use for when you want a real README for your users.
To use this plugin, include it after
pouchdb.js in your HTML page:
Or to use it in Node.js, just npm install it:
npm install pouchdb-envoy
And then attach it to the
var PouchDB = ;PouchDB;