liber

liber

Liber makes using CouchDB not only easier to build but also shemaless. It is built on nano and inspired by AngularJS-Resource. Principles:

• Minimalistic: Keep functions you would be using(view generation etc.) once out of this one. CouchDB's api is simple - do them using nano.
• Shemaless: NoSQL is shemaless why should a driver differ.
• Expectedness: Don't try to squeeze features of a RDBMS out of CouchDB, ergo don't generate anything automatically in the background. Be in control and know whats happening.

Installation

Liber is nothing but a extended api for nano so for using it you also need the latter - it's good to have anyways working with CouchDB:

npm install liber nano

Getting started

to set libre up

var nano = require('nano')('http://localhost:5984/mydatabase');
var Liber = require('liber')(db); //alias for document

now... live a simpler life

Liber.getOne('bobs_id', function (err, bob) {
  bob.age++;
  bob.save(function (err, newBob) {
    //newBob == bob;
  });
});

##Inheritance

<!-- //Liber.inherit(Constructor, prototype, options); where Liber already has a pointer to database. -->

function User(data) {
  this.superClass.call(this, data); // needed to give more flexibility
                                    // to construction process
  this.kind = 'user';
  this.fullName = this.lastName + ', ' + this.firstName;
}

User = Liber.inherit(User, {
  changePassword: function () { ... }
}, {
  'byLastName': ['designDoc', 'viewName']
});

User.get('anId', cb);
/*
  get by id
  Note: Liber doesn't validate the kind or type so you could
  fetch an User from any other Liber class.
*/

User.getByLastName('Smith', cb);
// get user from an generated view getter. Result is an array.

User.getOneByLastName('Smith', cb);
// same as the last one but result is User object.

##API: Class methods

###Libre.inherit ###Libre.parse ###Libre.get ###Libre.getOne ###Libre.getFromView ###Libre.getOneFromView

##API: Instance methods

###Doc.save ###Doc.insert ###Doc.destroy