Schema.prototype.loadClass()

Parameters
  • model «Function»
  • [virtualsOnly] «Boolean» if truthy, only pulls virtuals from the class, not methods or statics

Loads an ES6 class into a schema. Maps setters + getters, static methods, and instance methods to schema virtuals, statics, and methods.

Example:

  1. const md5 = require('md5');
  2. const userSchema = new Schema({ email: String });
  3. class UserClass {
  4.   // `gravatarImage` becomes a virtual
  5.   get gravatarImage() {
  6.     const hash = md5(this.email.toLowerCase());
  7.     return `https://www.gravatar.com/avatar/${hash}`;
  8.   }
  10.   // `getProfileUrl()` becomes a document method
  11.   getProfileUrl() {
  12.     return `https://mysite.com/${this.email}`;
  13.   }
  15.   // `findByEmail()` becomes a static
  16.   static findByEmail(email) {
  17.     return this.findOne({ email });
  18.   }
  19. }
  21. // `schema` will now have a `gravatarImage` virtual, a `getProfileUrl()` method,
  22. // and a `findByEmail()` static
  23. userSchema.loadClass(UserClass);