1.0.1 • Published 9 years ago
mongoose3-q v1.0.1
mongoose-q
kriskowal's Q support for mongoose 3.
for mongodb native nodejs driver, see mongo-q.
usage
to apply Q with default suffix 'Q':
var mongoose = require('mongoose-q')(require('mongoose'));
// verbose way: mongooseQ is unused
var mongoose = require('mongoose'),
mongooseQ = require('mongoose-q')(mongoose)
// shortest way: mongoose will be loaded by mongoose-q
var mongoose = require('mongoose-q')();
to apply another Q implementation(since v0.0.15):
var mongoose = require('mongoose-q')(require('mongoose'), {q:require('q-bluebird')});
use Q-applied model
statics:
SomeModel.findByIdQ(....blahblah...)
.then(function (result) { ... })
.catch(function (err) { ... })
.done();
use Q-applied model
methods:
var someModel = new SomeModel(...);
someModel.populateQ()
.then(function (result) { ... })
.catch(function (err) { ... })
.done();
use Q-applied query
methods:
SomeModel.find(...).where(...).skip(...).limit(...).sort(...).populate(...)
.execQ() // no 'Q' suffix for model statics except for execQ()
.then(function (result) { ... })
.catch(function (err) { ... })
.done();
use Q-applied aggregate
methods:
SomeModel.aggregate(...).project(...).group(...).match(...).skip(...).limit(...).sort(...).unwind(...)
.execQ() // no 'Q' suffix for model statics except for execQ()
.then(function (result) { ... })
.catch(function (err) { ... })
.done();
to apply Q with custom suffix
/prefix
:
var mongoose = require('mongoose-q')(require('mongoose'), {prefix:'promiseOf_', suffix:'_withQ'});
SomeModel.promiseOf_findAndUpdate_withQ(...)
.then(function (result) { ... })
.catch(function (err) { ... })
.done();
to apply Q with custom name mapper
:
function customMapper(name) {
return 'q' + name.charAt(0).toUpperCase() + name.substring(1);
}
var mongoose = require('mongoose-q')(require('mongoose'), {mapper:customMapper});
SomeModel.qFindAndUpdate(...)
.then(function (result) { ... })
.catch(function (err) { ... })
.done();
to apply Q with spread
:
var mongoose = require('mongoose-q')(require('mongoose'), {spread:true});
SomeModel.updateQ(...)
.spread(function (affectedRows, raw) { ... })
.catch(function (err) { ... })
.done();
SomeModel.updateQ(...)
.then(function (result) { var affectedRows = result[0], raw = result[1]; ... })
.catch(function (err) { ... })
.done();
...
var model = new SomeModel();
...
model.saveQ()
.spread(function (savedDoc, affectedRows) { ... })
.catch(function (err) { ... })
.done();
...
model.saveQ()
.then(function (result) { var savedDoc = result[0], affectedRows = result[1]; ... })
.catch(function (err) { ... })
.done();
NOTE: without
spread
option(by default), you can access only the first result withthen
!!
to define custom statics/instance methods using Q
SomeSchema.statics.findByName = function (name) {
return this.findQ({name: name}); // NOTE: returns Promise object.
};
...
var SomeModel = mongoose.model('Some', SomeSchema);
SomeModel.findByName('foo').then(function(result) {
console.log(result);
});
NOTE: this is not a feature of mongoose-q
That's all folks!