npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mongo-models

v3.0.4

Published

JavaScript class interfaces to MongoDB collections

Downloads

478

Readme

mongo-models

JavaScript class interfaces to MongoDB collections.

Build Status Dependency Status devDependency Status peerDependency Status

MongoDB's native driver for Node.js is pretty good. We just want a little sugar on top.

Mongoose is awesome, and big. It's built on top of MongoDB's native Node.js driver. It's a real deal ODM with tons of features. You should check it out.

We wanted something in between the MongoDB driver and Mongoose. A light weight abstraction where we can interact with collections via JavaScript classes and get document results as instances of those classes.

We're also big fans of the object schema validation library joi. Joi works well for defining a model's data schema.

API reference

https://github.com/jedireza/mongo-models/blob/master/API.md

See the old v1.x API reference.

Install

$ npm install mongo-models

Usage

Creating models

You extend the MongoModels class to create new model classes that map to MongoDB collections.

Let's create a Customer model.

'use strict';
const Joi = require('joi');
const MongoModels = require('mongo-models');

const schema = Joi.object({
    _id: Joi.object(),
    name: Joi.string().required(),
    email: Joi.string().email(),
    phone: Joi.string()
});

class Customer extends MongoModels {
    static create(name, email, phone) {

        const document = new Customer({
            name,
            email,
            phone
        });

        return this.insertOne(document);
    }

    speak() {

        console.log(`${this.name}: call me at ${this.phone}.`);
    }
}

Customer.collectionName = 'customers'; // the mongodb collection name
Customer.schema = schema;

module.exports = Customer;

Example

'use strict';
const BodyParser = require('body-parser');
const Customer = require('./customer');
const Express = require('express');
const MongoModels = require('mongo-models');

const app = Express();
const connection = {
    uri: process.env.MONGODB_URI,
    db: process.env.MONGODB_NAME
};

app.use(BodyParser.json());

app.post('/customers', async (req, res) => {

    const name = req.body.name;
    const email = req.body.email;
    const phone = req.body.phone;
    let customers;

    try {
        customers = await Customer.create(name, email, phone);
    }
    catch (err) {
        res.status(500).json({ error: 'something blew up' });
        return;
    }

    res.json(customers[0]);
});

app.get('/customers', async (req, res) => {

    const name = req.query.name;
    const filter = {};

    if (name) {
        filter.name = name;
    }

    let customers;

    try {
        customers = await Customer.find(filter);
    }
    catch (err) {
        res.status(500).json({ error: 'something blew up' });
        return;
    }

    res.json(customers);
});

const main = async function () {

    await MongoModels.connect(connection, {});

    console.log('Models are now connected.');

    await app.listen(process.env.PORT);

    console.log(`Server is running on port ${process.env.PORT}`);
};

main();

Run the example

To run the example, first clone this repo and install the dependencies.

$ git clone https://github.com/jedireza/mongo-models.git
$ cd mongo-models
$ npm install

The example is a simple Express API that uses the Customer model we created above. View the code.

$ npm run example

Have a question?

Any issues or questions (no matter how basic), open an issue. Please take the initiative to read relevant documentation and be pro-active with debugging.

Want to contribute?

Contributions are welcome. If you're changing something non-trivial, you may want to submit an issue before creating a large pull request.

License

MIT

Don't forget

What you create with mongo-models is more important than mongo-models.