Query.prototype.toConstructor()

Returns:
  • «Query» subclass-of-Query

Converts this query to a customized, reusable query constructor with all arguments and options retained.

Example

  1. // Create a query for adventure movies and read from the primary
  2. // node in the replica-set unless it is down, in which case we'll
  3. // read from a secondary node.
  4. const query = Movie.find({ tags: 'adventure' }).read('primaryPreferred');
  6. // create a custom Query constructor based off these settings
  7. const Adventure = query.toConstructor();
  9. // Adventure is now a subclass of mongoose.Query and works the same way but with the
  10. // default query parameters and options set.
  11. Adventure().exec(callback)
  13. // further narrow down our query results while still using the previous settings
  14. Adventure().where({ name: /^Life/ }).exec(callback);
  16. // since Adventure is a stand-alone constructor we can also add our own
  17. // helper methods and getters without impacting global queries
  18. Adventure.prototype.startsWith = function (prefix) {
  19.   this.where({ name: new RegExp('^' + prefix) })
  20.   return this;
  21. }
  22. Object.defineProperty(Adventure.prototype, 'highlyRated', {
  23.   get: function () {
  24.     this.where({ rating: { $gt: 4.5 }});
  25.     return this;
  26.   }
  27. })
  28. Adventure().highlyRated.startsWith('Life').exec(callback)