🚀 Mongoose Model TS

mongoose-model-ts is a package for Typescript node projects to use mongoose in a typed way.

Getting Started

Here is a basic example of how you can use this package:

Prerequisites

TypeScript 3.7+
Node 8.10+
mongoose ^5.9.2

Installing

You can download and install this package using npm:

npm i --save mongoose-model-ts

Gets started

With JS mongoose:

const  mongoose  =  require('mongoose');
const { Schema } = mongoose;
const { ObjectId } = Schema.Types;
const { Editorial } = './editorial';
const { Enemy } = './enemy';

const  HeroSchema  =  new  Schema({
	name: { 
		type:  String 
	},
	superpower: { 
		type:  String, 
		required:  true 
	},
	editorial: { 
		type:  ObjectId, 
		ref: 'Editorial' 
	},
	enemies: [{ 
		type: ObjectId, 
		ref: 'Enemy' 
	}],
})

mongoose.model('Hero', HeroSchema);

With TS mongoose:

import { prop, Model, entity } from  'mongoose-model-ts'
import { Editorial } from './editorial';
import { Enemy } from './enemy';

@entity
export  class  Hero  extends  Model {

	@prop()
	name:  string;

	@prop({ required:  true })
	superpower:  string;

	@prop({ ref: Editorial })
	editorial:  Editorial;

	@prop({ ref: Enemy })
	enemies:  Enemy[];

}

How it works

Mongoose TS maps the properties of the model and creates a schema in the metadata of the class. This is transparent to the developer as they don't need to worry about how it works.

Create

	const hero = await Hero.create({name: 'Batman', superpower: 'Be cool' });

Find (One, many, byId)

	const query = { /* ... */ };
	
	const hero = await Hero.find(query);
	const hero = await Hero.findByUd(/*id*/);
	const hero = await Hero.findOne(query);

Save

You can Save, Create or Update if the record exist in the database.

	// SAVE NEW RECORD
	const hero = new Hero;
	hero.name = 'Superman';
	hero.superpower = 'Too much to be fair';
	await hero.save();
	
	// UPDATE EXISTING RECORD
	const hero = await Hero.findByUd(/*id*/);
	hero.superpower = 'new super amazing power';
	hero.save();

Update

The same as Save() function when the record exist.

	// UPDATE EXISTING RECORD
	const hero = await Hero.findByUd(/*id*/);
	hero.name = 'Another craze and cool name';
	hero.update();

Autofill

The package allows you to access to a ref object directly without search, the package search and populate automaticly.

	const hero = await Hero.findByUd(/*id*/);
	
	// This automaticly find the editorial and save this into editorial property
	const editorial = hero.editorial.name;

In this moment the package is un ultra mega archi pre-alpha. In the next weeks new cool features will be uploaded. Until then, we are open to all recomendations to improve this package.

License

This project is licensed under the MIT License - see the LICENSE file for details

ralcorta/mongoose-model-ts