Git Product home page Git Product logo

mongoose-decorators's Introduction

mongoose-decorators Build Status

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() {}
}

// User is now mongoose model

var john = new User({name: 'John'});
john.save();
console.log(john.name); // 'John'
console.log(john.foo); // [Function: foo]

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

mongoose-decorators's People

Contributors

aksyonov avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

hcnode

mongoose-decorators's Issues

Show usage

Can you show preferred way to access model decorators for generating schema?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.