Node.js SDK 2.0 for Usergrid
Currently a work in progress; documentation and implementation are subject to change.
Note: Node.js SDK 2.0 for Usergrid is not backwards compatible with 0.1X versions of the SDK. If your application is dependent on the 0.1X set of Node.js APIs, you will need to continue using the 0.1X version (see below for installation instructions).
Release Candidate 0, available here or on npm
Please open an issue
To install the latest stable 0.1X build:
npm install usergrid
(Or add "usergrid": "~0.10.11"
to your package.json)
To install the 2.0 release candidates, install from npm, specifying the version ~2.0.0-rc
:
npm install usergrid@~2.0.0-rc
(Or add "usergrid": "~2.0.0-rc"
to your package.json)
If you want access to the latest development build (you will need to run npm install
to keep it up to date):
npm install r3mus/usergrid-nodejs
Note: This section is left intentionally light. In its current release candidate state, this SDK is only recommended for developers familiar with Usergrid, Node.js, and preferably Mocha tests. For full usage and implementation, have a look in /tests
.
There are two fundamental ways to use the new Node SDK:
Singleton pattern:
var Usergrid = require('usergrid') Usergrid.init({ orgId: ..., appId: ... }) // or from a config file, see config.sample.json var Usergrid = require('usergrid') Usergrid.init() // defaults to use config.json
Instance pattern (primarily used when connecting to multiple Usergrid targets):
var UsergridClient = require('./node_modules/usergrid/lib/client') var client = new UsergridClient(config)