anytv-node-mongo

Our version of mongoskin that makes connecting to mongo simpler. Especially made for our awesome expressjs boilerplate.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Jan 11, 2018Jan 20, 2015Minified + gzip package size for anytv-node-mongo in KB

Readme

anytv-node-mongo

Build Status Coverage Status Documentation Dependencies

Our version of mongoskin that makes connecting to mongo simpler. Especially made for our awesome expressjs boilerplate.

This module uses the popular mongoskin.

Install

npm install anytv-node-mongo --save

Features

  • Simpler connection with mongo.open(config)

Usage

Opening a connection

On your index.js / server.js / app.js, register your database using a key.

import mongo from 'anytv-node-mongo';

const config = {
    host: 'localhost',
    user: 'root',
    password: '',
    database: test
};

mongo.open(config)
    .collection('users')
    .findOne({_id: 'SOMEID'}, callback);

Documentation

Code documentation can be found at (https://doc.esdoc.org/github.com/anyTV/anytv-node-mongo/)[https://doc.esdoc.org/github.com/anyTV/anytv-node-mongo/].

Contributing

Install the tools needed:

npm install babel -g
npm install esdoc -g
npm install mocha -g
npm install --dev

To compile the ES6 source code to ES5:

babel src --watch --out-dir lib

To generate the docs:

npm run docs

Running test

npm test

Code coverage

npm run coverage

Then open coverage/lcov-report/index.html.

License

MIT

Author

Freedom! Labs, any.TV Limited DBA Freedom!

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.