class-mongo v5.0.1

Lightweight but powerful MongoDB ORM on top of class entities. Backed by mongodb native driver.

with TypeScript support

• class-json is used as a Serialization and Validation library.

  this is loosely coupled and can be replaced with any other

• Can be decoupled from base classes:

  you may want to share same models in nodejs and browser environments

Short example to get the feeling.

import { Serializable, Json, Rule } from 'class-json'

export class User extends Serializable<User> {
    _id: string

    @Rule.required()
    name: string

    @Rule.pattern(/@/)
    email: string

    @Json.type(Date)
    createdAt = new Date()

    @Json.type(BigInt)
    amount: bigint
}

import { User } from './User'
import { MongoEntityFor, table, index, dbType } from 'class-mongo'


@table('users')
export class UserDb extends MongoEntityFor(User) {

    @index({ unique: true })
    email: string

    /*(MongoType, JsType)*/
    @dbType('decimal', BigInt)
    amount: bigint
}


// e.g
let user = new UserDb({
    name: 'Smith',
    email: 'foo@bar.fake'
});
await user.upsert();
console.log(user._id);

Same as a single class:

import { Serializable, Json, Rule } from 'class-json'
import { MongoEntity, table, index } from 'class-mongo'

@table('users')
export class User extends MongoEntity<User> {
    _id: string

    @index({ unique: true })
    @Rule.required()
    name: string

    @Rule.pattern(/@/)
    email: string

    @Json.type(Date)
    createdAt: Date
}

☰ API

• 1 class MongoEntity - 1.01 static fetch

  • 1.02 static fetchPartial - 1.03 static fetchMany
  • 1.04 static fetchManyPartial
  • 1.05 static fetchManyPaged
  • 1.06 static fetchManyPagedPartial
  • 1.07 static count
  • 1.08 static upsert
  • 1.09 static upsertBy
  • 1.10 static upsertMany
  • 1.11 static upsertManyBy
  • 1.12 static patch
  • 1.13 static del

  • 1.14 static delMany

  • 1.15 static getCollection

  • 1.16 static getDb

  • 1.17 .upsert

  • 1.18 .patch
  • 1.19 .del

• 2 namespace MongoSettings

  • 2.1 define
  • 2.2 interface IMongoSettings
    • 2.2.1 connection
    • 2.2.2 db
    • 2.2.3 ip
    • 2.2.4 port
    • 2.2.5 name

• 3 namespace MongoIndexes

  • 3.1 ensureAll

• 4 decorators

  • 4.1 table
  • 4.2 index
  • 4.3 dbType

1 MongoEntity

1.01 static fetch

• Parameters: #findOne
• Returns: class instance

let user = await UserEntity.fetch({ username: 'foo' });

1.02 static fetchPartial

Similar to fetch but has strongly typed Input projection and strongly typed Output partial entity model.

• Parameters: #findOne
• Returns: class instance with omitted fields not included in projection

let user = await UserEntity.fetchPartial({ username: 'foo' }, {
    projection: {
        email: 1
    }
});

// User is of type Pick<UserEntity, 'email'>
console.log(user.email); // OK
console.log(user.username); // TypeScript Error

1.03 static fetchMany

• Parameters: #find
• Returns: array of class instances

let users = await UserEntity.fetchMany({ visits: { $gte: 100 }});

1.03 static fetchManyPartial

• Parameters: #find
• Returns: array of class instances with omitted fields not included in projection

let users = await UserEntity.fetchMany({
    visits: { $gte: 100 }
}, {
    projection: {  username: 1 }
});

1.03 static fetchManyPaged

Similar to fetchMany but requires limit and skip, returns also total amount of documents.

• Parameters: #find
• Returns: { collection: InstanceType<T>[], total: number }

let users = await UserEntity.fetchMany({
    visits: { $gte: 100 }
}, {
    sort: { username: 1 },
    limit: 50,
    skip: 0
});

1.03 static fetchManyPagedPartial

Similar to fetchManyPaged but also requires projection field and returns strongly types models.

• Parameters: #find
• Returns: { collection: InstanceType<Partial<T>>[], total: number }

let users = await UserEntity.fetchMany({
    visits: { $gte: 100 }
}, {
    sort: { username: 1 },
    limit: 50,
    skip: 0
});

1.03 static count

• Parameters: #countDocuments
• Returns: number

1.05 static upsert

• Parameters: #updateOne / #insertOne
• Returns: class entity (with _id field set in case of insert action)

If _id is not present the model will be inserted, otherwise updated.

let user = await UserEntity.upsert({ username: 'foo', email: 'foo@bar.foo' });

1.05 static upsertBy

• Parameters: #updateOne / #insertOne
• Returns: class entity (with _id field set in case of insert action)

Inserts or updates the document based on the field value

let user = await UserEntity.upsertBy('username', { username: 'foo', email: 'foo@bar.foo' }, {});

1.05 static upsertMany

• Parameters: #updateOne / #insertOne
• Returns: array of class entities

1.05 static upsertManyBy

• Parameters: #updateOne / #insertOne
• Returns: array of class entities

2 MongoSettings

2.1 define

Configurate mongo connection before making any mongodb requests

import { MongoSettings } from 'class-mongo';

MongoSettings.define({
    db: 'fooTables'
    connection: 'connection_string';
    params: {
        // additional parameters if needed
    }
});

:copyright: MIT - Atma.js