clerk

clerk

CouchDB library for node and the browser and sister project to sage

var clerk = require('clerk');

var client = clerk('http://127.0.0.1:5984');

var db = client.db('test');

db.info(function(err, info) {
  console.dir(err || info);
});

Installation

$ npm install clerk

Browser Support

Browser support is provided by superagent. The browser versions of the library may be found under the dist/ directory. The browser files are updated on each versioned release, but not for development. Modern browsers are generally supported, but not widely tested. Karma is used to run the mocha tests in the browser.

Security restrictions on cross-domain requests currently limits the usefulness of the browser version. Using a local proxy or configuring Cross-Origin Resource Sharing in CouchDB may allow you to use the library in the browser. Please see the configuration notes in the testing section for more information about CouchDB CORS support.

To build the client files:

$ npm run dist

Testing

To run tests in node:

$ npm test

To run tests with Karma, make sure that you have enabled cors in CouchDB. By default, CouchDB does not allow the Authorization header, so if you will be authenticating, you'll need to add it to the list as well.

[httpd]
enable_cors = true

[cors]
credentials = true
origins = *
headers = Accept, Accept-Language, Authorization, Content-Type, Expires, Last-Modified, Pragma, Origin, Content-Length, If-Match, Destination, X-Requested-With, X-Http-Method-Override, Content-Range

Then, you may run Karma:

$ npm run karma

Philosophy

The philosophy of clerk is to provide a thin wrapper around the CouchDB API, making the database easier to use from JavaScript. clerk is designed to quickly allow you to get started with CouchDB. As you get more comfortable with clerk and CouchDB, clerk gives you full access to CouchDB's more advanced features.

The library API generally follows the RESTful API, so you can use the CouchDB docs as well as the clerk docs to build your applications. If a feature is missing from clerk or you need to access more advanced features, the request method allows you to send custom requests directly to CouchDB.

License

Copyright 2012-2015 Michael Phan-Ba <[e-mail]>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

<http://www.apache.org/licenses/LICENSE-2.0>

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.