cdb

Table of Contents
=================

* cdb
* Install
* Developer
* Test
* Cover
* Lint
* Clean
* Import
* Readme

cdb
===

.

Library for couchdb designed for rlx using request.

This module differs from modules such as nano in that it is designed to have feature parity with the couch-api. As such it exhibits some interesting behaviour:

1. Encapsulates many constants for couchdb, see constants.
2. Stashes request information so that a history of requests is available and the last request may be repeated (useful for lazy authentication).
3. Exposes schema descriptors that may be used with async-validate, see schema.

Install

``
npm i cdb --save
`

Developer

$3

Run the test specifications:

`
npm test
`

$3

To generate code coverage run:

`
npm run cover
`

$3

Run the source tree through jshint and jscs:

`
npm run lint
`

$3

Remove generated files:

`
npm run clean
`

$3

Imports configuration data from default.ini into config.js:

`
npm run import
`

$3

To build the readme file from the partial definitions:

`
npm run readme
``

Generated by mdp(1).

[couchdb]: http://couchdb.apache.org
[couch-api]: http://docs.couchdb.org/en/latest/api/
[async-validate]: https://github.com/tmpfs/async-validate
[nano]: https://github.com/dscape/nano
[request]: https://github.com/mikeal/request
[node]: http://nodejs.org
[npm]: http://www.npmjs.org
[rlx]: https://github.com/tmpfs/rlx
[jshint]: http://jshint.com
[jscs]: http://jscs.info