{"id":16327265,"url":"https://github.com/bryopsida/nest-couchdb","last_synced_at":"2025-03-22T22:31:09.691Z","repository":{"id":172497994,"uuid":"649363386","full_name":"bryopsida/nest-couchdb","owner":"bryopsida","description":"CouchDB module for NestJS","archived":false,"fork":false,"pushed_at":"2025-02-28T09:37:29.000Z","size":941,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-28T16:33:11.979Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"scalio/nest-couchdb","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bryopsida.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-04T16:04:55.000Z","updated_at":"2025-01-17T23:09:49.000Z","dependencies_parsed_at":"2023-12-18T01:28:43.503Z","dependency_job_id":"ac474c1a-f32d-48d5-84fa-a9be7e189045","html_url":"https://github.com/bryopsida/nest-couchdb","commit_stats":null,"previous_names":["bryopsida/nest-couchdb"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnest-couchdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnest-couchdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnest-couchdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnest-couchdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryopsida","download_url":"https://codeload.github.com/bryopsida/nest-couchdb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244246552,"owners_count":20422459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T23:10:53.875Z","updated_at":"2025-03-22T22:31:09.322Z","avatar_url":"https://github.com/bryopsida.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NestJS CouchDB\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_nest-couchdb\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=bryopsida_nest-couchdb) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_nest-couchdb\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=bryopsida_nest-couchdb) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_nest-couchdb\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=bryopsida_nest-couchdb) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_nest-couchdb\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=bryopsida_nest-couchdb) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_nest-couchdb\u0026metric=code_smells)](https://sonarcloud.io/summary/new_code?id=bryopsida_nest-couchdb) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=bryopsida_nest-couchdb\u0026metric=bugs)](https://sonarcloud.io/summary/new_code?id=bryopsida_nest-couchdb)\n\nA \u003ca href=\"http://couchdb.apache.org/\"\u003eCouchDB\u003c/a\u003e module for \u003ca href=\"https://nestjs.com/\"\u003eNestJS\u003c/a\u003e\n\n## Installation\n\n```bash\n$ npm i @bryopsida/nest-couchdb nano\n```\n\n## Usage\n\n`@bryopsida/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 '@bryopsida/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 '@bryopsida/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 '@bryopsida/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 '@bryopsida/nest-couchdb';\nimport { Cat } from './cat.entity';\n\n@Injectable()\nexport class CatsService {\n  constructor(\n    @InjectRepository(Cat)\n    private readonly catsRepository: Repository\u003cCat\u003e,\n  ) {}\n\n  findAll(): Promise\u003cDocumentListResponse\u003cCat\u003e {\n    return this.catsRepository.list();\n  }\n}\n```\n\n## Test\n\n```bash\n$ docker-compose up -d\n$ npm test\n```\n\n## License\n\n[MIT](LICENSE)\n\n## Credits\n\nCreated by [@zMotivat0r](https://github.com/zMotivat0r) @ [Scalio](https://scal.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryopsida%2Fnest-couchdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryopsida%2Fnest-couchdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryopsida%2Fnest-couchdb/lists"}