@auxilin/node-mongo

Node Mongo

Node Mongo — is reactive extension to MongoDB API. It provides few usability improvements to the monk API.

Features

• ️️🚀 Reactive fires events as document stored, updated or deleted from database. That helps to keep your database updates for different entities weakly coupled with each other
• 🔥 Paging implements high level paging API
• ⚡️ Schema validation based on joi

Installation

npm i @auxilin/node-mongo

Quick example

Connect to the database:

const connectionString = `mongodb://localhost:27017/home-db`;
const db = require('node-mongo').connect(connectionString);

Short API overview, for more details see Full API reference

//create a service to work with specific database collection
const usersService = db.createService('users');

// find a single document
const user = await usersService.findById('123');

// sample paging
const result = await usersService.find({ name: 'Bob' }, { page: 1, perPage: 30 });
// returns object like this:
// {
//   results: [], // array of user entities
//   pagesCount, // total number of pages
//   count, // total count of documents found by query
// }

//update document
const updatedUser = await usersService.update({ _id: '1'}, (doc) => {
  doc.name = 'Alex';
});

// subscribe to document updates
userService.on('updated', ({ doc, prevDoc }) => {
});

Schema declaration (user.schema.js):

const Joi = require('@hapi/joi');

const companySchema = {
  _id: Joi.string(),
  createdOn: Joi.date(),
  name: Joi.string(),
  status: Joi.string().valid('active', 'inactive'),
};

const joiOptions = {};

module.exports = (obj) => Joi.validate(obj, companySchema, joiOptions);

Schema validation:

const schema = require('./user.schema')
const usersService = db.createService('users', schema);

Full API Reference

API Reference.

Change Log

This project adheres to Semantic Versioning. Every release is documented on the Github Releases page.

License

Node-mongo is released under the MIT License.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Contributors

Thanks goes to these wonderful people (emoji key):

Evgeny Zhivitsa 💬 💻 🎨 📖 💡 🤔 👀 ⚠️

Andrew Orsich 📖 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!