function( Express.Application app, //the express application Object options //options for usage with the library. see options below. )

app.model( String name, //name of the model Object schema, //plain object defining a mongoose schema. Object schemaOptions, // optional schemaOptions to pass to the mongoose schema constructor Function callback //optional a function callback that receives the generated mongoose schema. for adding indexes, static methods, instance methods, plugins to model. )

function( Express.Application app, //the Express app mongoose.Schema.Types Types,//the mongoose.Schema.Types object for convenience/brevity. )

var app = require('express')(); // 1. include express require('express-mongoose-helper')(app,{ path: __dirname + '/models/', connectionString: 'mongodb://localhost/test', debug: true }); //if you want to load your controllers,start your app, any other action requiring the models to be loaded/defined // you may listen for the 'mongoose.models.ready' event like so: app.on('mongoose.models.ready',function(){ // your models are now available on the express app const dog = new app.model.Dog({ name: 'Rowdy', owner: null }); dog.save().then(dog=>{ console.log(dog.name); // Rowdy }) //load your controllers here, so that models are available. app.listen(3000);//start up our server });

//an example mongoose model in express-mongoose-helper //your module should export a function like so. //you can customize which arguments are injected, the defaults are shown below. module.exports = function( app, Types ){ //creates a mongoose model named user and adds it to the express app. app.model('User',{ name: { first: String, middle: String, last: String, }, email: String, referredBy: { type: Types.ObjectId, ref: 'User', default: null } },function(schema){ //here you can add indexes, static methods, instance methods, plugins etc to the schema. schema.index({ email: 1},{unique: true}); }); // now you can access the model like `app.model.User` from your controllers. };

const {standalone} = require('express-mongoose-helper'); const app = standalone({ path: __dirname + '/models/', connectionString: 'mongodb://localhost/your-db', debug: true }); app.on('mongoose.models.ready',function(){ // your backend code here });

const model = app.model('Test',{foo:String},(schema,mongoose)=>{ //modify the schema here //you can use mongoose here too }); const mongoose = model.mongoose();// do something with mongoose

module.exports = function( app, Types ){ app.model('UploadedFile',{ path: String, owner: { type: Types.ObjectId, ref: 'User' }, mimetype: String, filesize: Number, }, { timestamps: true },function(schema){ schema.index({ filesize: 1 }); }); };

//default options options = { connectionString: '',// mongodb connection string connectionOptions: {},// mongodb connection options path: '',// path to folder containing models inject: ['app','types'], //arguments to inject into each required model debug: false, //show log messages log: function(){ return this.debug && console.log.apply(console,arguments); }, //default logging function, can be changed extend: function(mongoose){} //extend mongoose with global plugins, custom types, etc. };