https://github.com/nigelhanlon/fastify-couchdb

Fastify CouchDB connection plugin
https://github.com/nigelhanlon/fastify-couchdb

couchdb database fastify nano

Last synced: 12 days ago
JSON representation

Fastify CouchDB connection plugin

• Host: GitHub
• URL: https://github.com/nigelhanlon/fastify-couchdb
• Owner: nigelhanlon
• License: other
• Created: 2018-04-19T09:23:10.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-09T23:37:40.000Z (over 1 year ago)
• Last Synced: 2024-12-19T16:38:55.271Z (24 days ago)
• Topics: couchdb, database, fastify, nano
• Language: JavaScript
• Size: 13.7 KB
• Stars: 9
• Watchers: 0
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-fastify - `fastify-couchdb`

README

        
# fastify-couchdb

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)

Fastify CouchDB connection plugin, with this you can share the same CouchDB connection in every part of your server.

Under the hood the popular [nano](https://github.com/apache/couchdb-nano) module is used, with the options that you pass to `register` passed to the nano instance.

## Install

```

npm i fastify-couchdb --save

```

## Usage

Simply add it to your project with `register` and you're done!

When registering you can pass any [options](https://github.com/apache/nano#configuration) supported by `nano` to the plugin:

```js

  fastify.register(require('fastify-couchdb'), {

    url: 'http://localhost:5984',

    requestDefaults : { "proxy" : "http://someproxy" },

    // etc

  })

```

This plugin will add the `couch` namespace in your Fastify instance which you can treat exactly like an instance of nano. Inside your routes you can then access the full range of nano's [methods documented here](https://github.com/apache/nano#getting-started).

**Example**:

```js

const fastify = require('fastify')

fastify.register(require('fastify-couchdb'), {

  url: 'http://localhost:5984'

})

fastify.get('/rabbit', (req, reply) => {

  const rabbits = this.couch.db.use('rabbits')

  rabbits.get('whiterabbit', function(err, body) {

    reply.send(err || body)

  });

})

```

Async await is support as well if you prefer:

```js

const fastify = require('fastify')

fastify.register(require('fastify-couchdb'), {

  url: 'http://localhost:5984'

})

fastify.get('/rabbit', async (req, reply) => {

  try {

    const rabbits = fastify.couch.db.use('rabbits');

    const body = await rabbits.get('whiterabbit')

    reply.send(body);

  }

  catch(err) {

    reply.send(err);

  }

})

```

## Development and Testing

First, start couchdb with:

```

$ npm run couchdb

```

Then in another terminal:

```

$ npm test

```

## License

Licensed under [Apache-2.0](./LICENSE).