\n
\n \n ![](\"https://raw.githubusercontent.com/scalio/bazel-status/master/assets/scalio-logo.svg?sanitize=true\"){kind=logo}
\n \n
\n
\n A CouchDB module for NestJS\n
\n\n[](https://circleci.com/gh/scalio/nest-couchdb/tree/master)\n\n \n\n## Installation\n\n```bash\n$ npm i @scalio/nest-couchdb nano\n```\n\n## Usage\n\n`@scalio/nest-couchdb` uses [nano](https://www.npmjs.com/package/nano) as a data provider for CouchDB and the `Repository` pattern to handle all documents related operations.\n\nFirst, let's create an `Entity`:\n\n```typescript\nimport { Entity, CouchDbEntity } from '@scalio/nest-couchdb';\n\n@Entity('cats')\nexport class Cat extends CouchDbEntity {\n name: string;\n}\n```\n\nWhere `cats` is the CouchDB database name.\n\nThe `CouchDbEntity` is a base class which has some common properties:\n\n```typescript\nclass CouchDbEntity {\n _id: string;\n _rev: string;\n}\n```\n\nThen, we need to import `CouchDbModule` in our `ApplicationModule`:\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { CouchDbModule } from '@scalio/nest-couchdb';\n\n@Module({\n imports: [\n CouchDbModule.forRoot({\n url: 'http://localhost:5984',\n username: 'couchdb',\n userpass: 'password',\n requestDefaults: { jar: true },\n }),\n ],\n})\nexport class ApplicationModule {}\n```\n\nIn our `CatsModule` we need to initiate repository for our `Cat` entity:\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { CouchDbModule } from '@scalio/nest-couchdb';\nimport { CatsService } from './cats.service';\nimport { CatsController } from './cats.controller';\nimport { Cat } from './cat.entity';\n\n@Module({\n imports: [CouchDbModule.forFeature([Cat])],\n providers: [CatsService],\n controllers: [CatsController],\n})\nexport class CatsModule {}\n```\n\nAnd here is the usage of the repository in the service:\n\n```typescript\nimport { DocumentListResponse } from 'nano';\nimport { Injectable } from '@nestjs/common';\nimport { InjectRepository, Repository } from '@scalio/nest-couchdb';\nimport { Cat } from './cat.entity';\n\n@Injectable()\nexport class CatsService {\n constructor(\n @InjectRepository(Cat)\n private readonly catsRepository: Repository\n
\n \n \n \n
\n