Nano

Offical Apache CouchDB library for Node.js.

Note: Nano >=11.0.0 is a breaking change for Node.js versions 16 and older. Nano 11 uses Node.js's built-in "fetch" HTTP client but this is only available in Node.js versions 18 or later. If you are using Node 16 or older then continue using Nano 10. See our migration guide for moving from Nano 10 to Nano 11.

Features:

• Minimalistic - There is only a minimum of abstraction between you and CouchDB.
• Pipes - Proxy requests from CouchDB directly to your end user. ( ...AsStream functions only)
• Promises - The vast majority of library calls return native Promises.
• TypeScript - Detailed TypeScript definitions are built in.
• Errors - Errors are proxied directly from CouchDB: if you know CouchDB you already know nano.

Installation

1. Install npm
2. npm install nano

or save nano as a dependency of your project with

npm install --save nano

Note the minimum required version of Node.js is 10.

Table of contents

• Getting started
• Tutorials & screencasts
• Configuration
• Database functions
  • nano.db.create(name)
  • nano.db.get(name)
  • nano.db.destroy(name)
  • nano.db.list()
  • nano.db.listAsStream()
  • nano.db.compact(name, [designname])
  • nano.db.replicate(source, target, [opts])
  • nano.db.replication.enable(source, target, [opts])
  • nano.db.replication.query(id, [opts])
  • nano.db.replication.disable(id, [opts])
  • nano.db.changes(name, [params])
  • nano.db.changesAsStream(name, [params])
  • nano.db.info()
  • nano.use(name)
  • nano.request(opts)
  • nano.config
  • nano.updates([params])

This is the beginning of the README. Read the rest at the original. Read the full README ↗