Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

An async wrapper for the CouchDB API, following Node.JS conventions

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

node-couchdb-api

This node.js module aims to provide a clean, asynchronous wrapper for the CouchDB API.

It uses callbacks that follow node.js conventions and aims to be as expressive as possible.

Installation

$ npm install couchdb-api

Usage

var couchdb = require("couchdb-api");

// connect to a couchdb server (defaults to http://localhost:5984)
var server = couchdb.srv();

// test it out!
server.info(function (err, response) {
console.log(response);

// should get { couchdb: "Welcome", version: "1.0.1" }
// if something went wrong, the `err` argument would provide the error that CouchDB provides
});

// select a database
var db = server.db("my-database");

db.info(function (err, response) {
console.log(response);

// should see the basic statistics for your test database
// if you chose a non-existant db, you'd get { error: "not_found", reason: "no_db_file" } in place of `err`
});

Refer to my website for documentation and resources.

Changelog

1.2.0

  • Complete documentation rewrite (now generated automatically via source code comments with dox)
  • Simplified the JSHint config by putting it into a single file at the root
  • Simplified the index.js entry-point. couchdb.srv() now only takes a single argument, a string URL.

1.1.5

  • Changed the package.json to allow for installs on node engine version 8
Something went wrong with that request. Please try again.