# dambreaker-mongo

> Mongo client for dambreaker

Latest version **1.0.1** (published 2018-04-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install dambreaker-mongo
pnpm add dambreaker-mongo
yarn add dambreaker-mongo
bun add dambreaker-mongo
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-04-12 |
| First published | 2018-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 310.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Benoît Claveau |
| Maintainers | benoit.claveau |
| Keywords | qwebs, mongo, mongodb, client, web, database, promise |

## Links

- npm: https://www.npmjs.com/package/dambreaker-mongo
- Repository: https://github.com/BenoitClaveau/dambreaker-mongo
- Issues: https://github.com/BenoitClaveau/dambreaker-mongo/issues
- npm.io page: https://npm.io/package/dambreaker-mongo

## Dependencies (4)

- [oups](https://npm.io/package/oups.md) latest
- [pump](https://npm.io/package/pump.md) latest
- [mongodb](https://npm.io/package/mongodb.md) latest
- [dambreaker](https://npm.io/package/dambreaker.md) latest

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-04-12
- 1.0.0 — 2018-04-12
- 0.0.2 — 2018-04-12
- 0.0.1 — 2018-04-12

## README

# dambreaker-mongo
[Mongo](https://www.npmjs.com/package/mongodb) service for [dambreaker](https://www.npmjs.com/package/dambreaker).

 [![NPM][npm-image]][npm-url]
 [![Build Status][travis-image]][travis-url]
 [![Coverage Status][coveralls-image]][coveralls-url]

## Features

  * [dambreaker](https://www.npmjs.com/package/dambreaker)
  * [Mongo API](http://mongodb.github.io/node-mongodb-native/2.3/api/)
  * Singleton

```js
return $mongo.db.then(db => {
  //db is a singleton Mongo Db instance
});
```

### Add the mongo connection string in dambreaker.json

```dambreaker.json
{
	"mongo": {
        "connectionString": "mongodb://localhost:27017/database"
    },
}
```

### Inject the dambreaker mongo service

```services.json
{
  "services": [
    { "name": "mongo", "location": "dambreaker-mongo" }
  ]
}
```

Or in javascript

```js
const DamBreaker = require("dambreaker");
const dambreaker = new DamBreaker();
dambreaker.inject("mongo" ,"dambreaker-mongo");
```

### Use REST api

```js

class Api {
    constructor(mongo) {    //mongo service is injected by dambreaker DI
        super("<collectionName>", mongo);
    };
```

### Override the default behaviour

```js
const { CRUD } = require("dambreaker-mongo");

class Api extends CRUD {
  constructor(mongo) {
    this.mongo = mongo;
  };
};
```

## Installation

```bash
$ npm install dambreaker-mongo
```

## Test

To run our tests, clone the dambreaker-mongo repo and install the dependencies.

```bash
$ git clone https://github.com/BenoitClaveau/dambreaker-mongo --depth 1
$ cd dambreaker-mongo
$ npm install
$ mongod --dbpath ./data/db
$ node.exe "../node_modules/mocha/bin/mocha" tests
```

[npm-image]: https://img.shields.io/npm/v/dambreaker-mongo.svg
[npm-url]: https://npmjs.org/package/dambreaker-mongo
[travis-image]: https://travis-ci.org/BenoitClaveau/dambreaker-mongo.svg?branch=master
[travis-url]: https://travis-ci.org/BenoitClaveau/dambreaker-mongo
[coveralls-image]: https://coveralls.io/repos/BenoitClaveau/dambreaker-mongo/badge.svg?branch=master&service=github
[coveralls-url]: https://coveralls.io/github/BenoitClaveau/dambreaker-mongo?branch=master

---
_Source: https://npm.io/package/dambreaker-mongo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._