Just a model-styled driver to work with MongoDB. Supports models, schemes, validations and custom methods for models.

Installation

npm i mongomod

Usage

To have an optimal level of control follow these steps:

Create a connection (Connection class)
Create a schema for a model (Schema class) [optional]
Create a model (createModel function)
Finally, create you object as instance of model (new Model())

Creating a connection

Initialize a connection which will allow all other stuff to be in touch with a database.

mongomod.Connection(options)

options (object) — connection parameters
options.link (string) — mongo connection link
options.login (string) — mongo login
options.password (string) — mongo password
options.dbName (string) — mongo database name
options.debug (boolean) — enable/disable debugging messages in console [default: false]
options.srv (boolean) — enable/disable srv in connection string (mongodb:// or mongodb+srv://) [default: true]

import mongomod from 'mongomod';

const db = new mongomod.Connection({
    link: 'your.link.mongodb.net',
    login: 'your_login',
    password: 'your_password',
    dbName: 'test'
});

Now you can open a connection...

await db.connect()

... and close it when needed

db.disconnect()

Creating a schema (optional)

Next up you may create a schema for a model that you are going to work with. This is an optional step so you may skip it if you don't want to validate data of your Model instances.

mongomod.Schema(schemaObj, options)

schemeObj (object) — object describing future model schema
options (object) — additional parameters
options.strict (boolean) — set true if you would like to follow schema in a strict way (all unwanted parameters are removed) [default: false]
options.debug (boolean) — enable/disable debuggin messages in console [default: false]

Create it like this:

import mongomod from 'mongomod';

const userSchema = new mongomod.Schema({
    name: 'string',
    age: ['number', 'null'],
    address: {
        city: 'string',
        coordinates: {
            x: 'number',
            y: 'number'
        }
    },
    education: ['object', 'null'],
    friends: 'array'
});

Allowed types:

Choose only one type for a field...

any
string
number
object
array
date
boolean
null

or combine them using an array like { city: ['string', 'null'] }

Creating your model

Now you are ready to create your first Model. Use crateModel function. Let's see how it works.

mongomod.createModel(db, collection, schema)

Creates an object that will be using for constructing a new instances of a Model.

db (object) — connection object created by MongoConnection class
collection (string) — name of collection that your model going to be linked to
schema (object) — schema object created by MongoScheme class... or nothing [default: null]

import mongomod from 'mongomod';

const UserModel = mongomod.createModel(db, 'users', userSchema)

Don't pass schema if you don't really need it:

// This will work...
const UserModel = mongomod.createModel(db, 'users')
// ...but schema is now your responsibility ;)

So the complete algorithm will be the following:

import mongomod from 'mongomod';

const db = new mongomod.Connection({
    link: 'your.link.mongodb.net',
    login: 'your_login',
    password: 'your_password',
    dbName: 'test'
});

const userSchema = new mongomod.Schema({
    name: 'string',
    lastName: 'string',
    age: ['number', 'null'],
    address: {
        city: 'string',
        coordinates: {
            x: 'number',
            y: 'number'
        }
    },
    education: ['object', 'null'],
    friends: 'array'
});

const User = createdModel(db, 'users', userSchema)

Great! If zero errors were thrown, you did everything right. Let's see what functionality does you Model have.

Working with a model

Model.init(data)

Allows to create new user with the data passed as an object.

data (object) — data for a model instance

const bro = new User()

bro.init({
    "name": "Barney",
    "lastName": "Stinson",
})

Model.data()

Returns current data

console.log(bro.data())

// Prints:
// {
//    "name": "Barney",
//    "lastName": "Stinson",
// }

// same as direct access to model data
console.log(bro.modelData)

Model.set(data)

Updates current item data without saving/inserting changes to the database. Merges existing data with a new set like { ... oldData, ...newData }

data (object) — object containing changes

user.set({ age: 38 })

Model.insert()

Inserts current item to the database. Use await as this method is asynchronous.

await user.insert()

Model.get(query)

Pulls data from the database using a query object. Use await as this method is asynchronous.

query (object) — regular MongoDB query

Previously we worked with new user that was created, updated, inserted. Let's see how to work with an existing user. First of all, create an instance of User model. Use Model.get(query) method to retrieve it from the database.

const user = new User()
await user.get({ name: 'Barney', lastName: 'Stinson' });

// ... or make it shorter
const user = await new User().get({ name: 'Barney', lastName: 'Stinson' })

Model.save(isNew)

Saves current user to the database.

isNew (boolean) — force to insert as a new document [default: false]

// Update document in the database...
await user.save()

// ... or insert it as a new one
await user.save(true) // same as user.insert()

Model.delete()

Deletes user in the database.

await user.delete()

Model.validate()

Validates item by a Schema specified.

You may check if the document matches its Model Schema.

user.validate() // returns true or false

Model.clearBySchema()

Deletes all properties that doesn't declared in schema.

console.log(bro.data())

// {
//    "name": "Barney",
//    "lastName": "Stinson",
//    "isLegendary": true
// }

// Ops! We don't expect that User Model has "isLegendary" field.
// Let's force data to exclude everything except Schema's fields

user.clearBySchema()

console.log(bro.data())
// {
//    "name": "Barney",
//    "lastName": "Stinson",
// }

// Great!

Custom Model methods

You may specify custom methods for a model with your logic.

const userSchema = new mongomod.Schema({
    name: 'string',
    lastName: 'string',
    age: ['number', 'null'],
})

const customMethods = {
    getFullName() {
        return this.modelData.name + ' ' + this.modelData.lastName
    },
    async increaseAge() {
        this.modelData.age = this.modelData.age + 1
        await this.save()
    }
}

const User = createdModel(db, 'users', userSchema, customMethods)
const bro = new User().init({
    name: 'Barney',
    lastName: 'Stinson'
    age: 29
})

console.log(bro.getFullName()) // Barney Stinson

await bro.increaseAge()
console.log(bro.data())
// {
//    name: 'Barney',
//    lastName: 'Stinson'
//    age: 30
// }

lesha2r/mongomod