Snark MongoDB Operator

Little utilitary module to access and operate on a Mongo Database.

Currently using NodeJS Mongo Driver v3.5

Installation

$> npm install @snark/mongodb-operator

Usage

project entry file

import { Database, IOptions } from "@snark/mongodb-operator";
import express from 'express';
import logger from "@snark/logger";

logger.addConsoleTransport();

const app = express();

const options: IOptions = {
    mongo: {
        database: "default",
        host: "localhost",
        port: 27017
    },
    logger: logger,
    collections: collections
};

const database = new Database(options);
global["db"] = database;

declare global {
    const db: Database
}

app.listen(3000)

project service file

// db is global and doesn't need to be imported.

app.get('/bar', (req: express.Request, res: express.Response, next: express.NextFunction) => {
    return db.find('user', {"name": { $in: usersArray }})
        .then(user => db.populate(user, 'basket', 'basketId'))
        .then(populatedUser => {
            res.status(200);
            res.json(populatedUser);
        })
        .catch(error => {
            console.log(error);
            res.status(500);
            res.json({"error": error});
        })
});

...

Documentation

Each exposed method is documented using JsDoc

In Webstorm use Ctrl + q to display the documentation of the highlighted method