mongoose-decorators

Decorators for mongoose models.

Installation

$ npm i mongoose mongoose-decorators --save

Usage

This library supports ECMAScript decorators proposal. To use decorators with babel you need to add transform-decorators-legacy plugin to .babelrc.

Example:

import {model, index, post} from 'mongoose-decorators';
 
@model({
  name: String,
  type: String
}, {
  autoIndex: false
})
@index({name: 1, type: -1})
export default class User {
  // class methods
  foo() {}
 
  @post('save')
  reindex() {}
}

model(definition, options, configure)

• definition (object) - will be passed to mongoose.Schema constructor
• options (object, optional) - will be passed to mongoose.Schema constructor
• configure (function, optional) - function for configuring schema. Some schema methods (create indexes, register plugins, etc.) should be called before model is created, you can do it in this function. It will be called with one argument - mongoose schema.

index, plugin

Decorators that wrap common used mongoose schema methods with the same options. These decorators must be used between model decorator and class definition.

pre, post

Method decorators that register middleware.

License

This library is under the MIT License