README
mongoose-base-repository
Promised based Mongoose Base Repository.
Installation
npm install mongoose-base-repository --save
Usage
Sample Schema:
'use strict';
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const UserSchema = new Schema({
id: {
type: Number,
required: true,
unique: true
},
name: {
type: String,
required: true,
trim: true
},
age: {
type: Number
},
active: {
type: Boolean,
default: true
}
});
mongoose.model('User', UserSchema);
Sample 1:
'use strict';
const MongooseRepository = require('mongoose-base-repository');
const userRepository = new MongooseRepository('User'); // Can be passed as mongoose.model('User') instance
userRepository.findOne({ name: 'test' }).then((user) => {
console.log(`User Name: ${user.name}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
Sample 2:
// UserRepository.js
'use strict';
const mongoose = require('mongoose');
const MongooseRepository = require('mongoose-base-repository');
const User = mongoose.model('User');
class UserRepository extends MongooseRepository {
constructor(foreignKeys) {
super(User, foreignKeys);
}
}
module.exports = new UserRepository();
// Test.js
'use strict';
const userRepository = require('./UserRepository');
userRepository.findOne({ name: 'test' }).then((user) => {
console.log(`User Name: ${user.name}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
FindOne
userRepository.findOne({ name: 'test' }).then((user) => {
console.log(`User Name: ${user.name}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
FindOne (with sort)
userRepository.findOne({ name: 'test' }, {age: -1}).then((user) => {
console.log(`User with name 'test' and has max age: ${user.name} (${user.age})`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
FindAll
userRepository.findAll({ name: 'test' }).then((users) => {
users.map((user) => {
console.log(`User Name: ${user.name}`);
});
}).catch((err) => {
console.log(`Error: ${err}`);
});
FindAll (with sort)
userRepository.findAll({ name: 'test' }, {age: 1}).then((users) => {
users.map((user) => {
console.log(`User Name: ${user.name}`);
});
}).catch((err) => {
console.log(`Error: ${err}`);
});
FindAll (with sort & limit)
userRepository.findAll({ name: 'test' }, {age: 1}, 1).then((users) => {
users.map((user) => {
console.log(`User Name: ${user.name}`);
});
}).catch((err) => {
console.log(`Error: ${err}`);
});
findSome
userRepository.findSome({ age: { $gte: 18 } }, 5, 'name').then((users) => {
users.map((user) => {
console.log(`User Name: ${user.name}`);
});
}).catch((err) => {
console.log(`Error: ${err}`);
});
findManyById
userRepository.findManyById([ '4ed3ede8844f0f351100000c', '4ed3f117a844e0471100000d' ]).then((users) => {
users.map((user) => {
console.log(`User Name: ${user.name}`);
});
}).catch((err) => {
console.log(`Error: ${err}`);
});
Aggregate
userRepository.aggregate([
{ '$match': { 'active': true } },
{ '$sort': { '_id': -1 } },
{ '$group': {
'_id': '$age',
'users': { '$push': '$ROOT' }
}
}
]).then((result) => {
result.users.map((user) => {
console.log(`User Name: ${user.name}`);
});
}).catch((err) => {
console.log(`Error: ${err}`);
});
create
userRepository.create({ name: 'test', age: 20 }).then((newUser) => {
console.log(`User Name: ${newUser.name}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
update
const dbUser = { /* .. */ };
userRepository.update(dbUser).then((user) => {
console.log(`User Name: ${user.name}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
remove
userRepository.remove({ name: 'test').then(() => {
console.log('User removed.');
}).catch((err) => {
console.log(`Error: ${err}`);
});
removeMany
userRepository.removeMany({ age: { $lte: 17 } }).then(() => {
console.log('Users under 18 are removed.');
}).catch((err) => {
console.log(`Error: ${err}`);
});
removeManyById
userRepository.removeManyById([ '4ed3ede8844f0f351100000c', '4ed3f117a844e0471100000d' ]).then((users) => {
console.log('User(s) removed.');
}).catch((err) => {
console.log(`Error: ${err}`);
});
removeAll
userRepository.removeAll().then(() => {
console.log('All users removed.');
}).catch((err) => {
console.log(`Error: ${err}`);
});
count
userRepository.count({ age: { $lte: 17 } }).then((count) => {
console.log(`Under 18 users count: ${count}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
findOneAndUpdate
userRepository.findOneAndUpdate({ name: 'test' }, { age: 25 }).then(() => {
console.log('User Updated.');
}).catch((err) => {
console.log(`Error: ${err}`);
});
Foreign Keys
Schema:
'use strict';
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const PostSchema = new Schema({
id: {
type: Number,
required: true,
unique: true
},
title: {
type: String,
required: true,
trim: true
},
content: {
type: String,
required: true,
trim: true
},
author: {
type: Schema.Types.ObjectId,
ref: 'User'
}
});
mongoose.model('Post', PostSchema);
Sample:
'use strict';
const MongooseRepository = require('mongoose-base-repository');
const postRepository = new MongooseRepository('Post', 'author'); // 'author' field here is a foreign key of User Schema
postRepository.findOne({ title: 'Test post' }).then((post) => {
// post.author now will have the respective user object
console.log(`Posted by: ${post.author.name}`);
}).catch((err) => {
console.log(`Error: ${err}`);
});
Tests
npm test
License
The MIT License (MIT)
Copyright (c) 2017 iiWebi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.