https://github.com/jorgecuesta/mongoose-plugins-recurrency

This package was created so some mongoose plugins could be installed only once per schema. And not every time a new model is created using that same schema.
https://github.com/jorgecuesta/mongoose-plugins-recurrency

mongoose mongoose-plugin mongoose-plugins-recurrency

Last synced: about 1 month ago
JSON representation

This package was created so some mongoose plugins could be installed only once per schema. And not every time a new model is created using that same schema.

• Host: GitHub
• URL: https://github.com/jorgecuesta/mongoose-plugins-recurrency
• Owner: jorgecuesta
• License: mit
• Created: 2016-06-05T00:40:58.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-06-14T16:44:23.000Z (over 8 years ago)
• Last Synced: 2024-04-26T22:03:13.104Z (8 months ago)
• Topics: mongoose, mongoose-plugin, mongoose-plugins-recurrency
• Language: JavaScript
• Size: 28.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## mongoose-plugins-recurrency

[![Build Status](https://travis-ci.org/jorgecuesta/mongoose-plugins-recurrency.svg?branch=master)](https://travis-ci.org/jorgecuesta/mongoose-plugins-recurrency)

[![Coverage Status](https://coveralls.io/repos/github/jorgecuesta/mongoose-plugins-recurrency/badge.svg?branch=master)](https://coveralls.io/github/jorgecuesta/mongoose-plugins-recurrency?branch=master)

[![npm version](https://badge.fury.io/js/mongoose-plugins-recurrency.svg)](https://badge.fury.io/js/mongoose-plugins-recurrency)

[![Dependency Status](https://david-dm.org/jorgecuesta/mongoose-plugins-recurrency.svg)](https://david-dm.org/jorgecuesta/mongoose-plugins-recurrency)

[![devDependency Status](https://david-dm.org/jorgecuesta/mongoose-plugins-recurrency/dev-status.svg)](https://david-dm.org/jorgecuesta/mongoose-plugins-recurrency#info=devDependencies)

[![peerDependency Status](https://david-dm.org/jorgecuesta/mongoose-plugins-recurrency/peer-status.svg)](https://david-dm.org/jorgecuesta/mongoose-plugins-recurrency#info=peerDependencies)

This package was created so some mongoose plugins could be installed only 

once per schema. And not every time a new model is created using that same schema.

The option passed is if the plugin should be applied recursively(mongoose normal behavior), 

or just once for that schema.

### Installation

`npm install mongoose-plugins-recurrency`

> @NOTE: It requires mongoose as peerDependency.

### Usage

```javascript

var mongoose = require('mongoose');

// It automatically adds logic to mongoose.

require('mongoose-plugins-recurrency');

// Register Global plugin with recursive flag set to false to prevent it to be called more than once.

mongoose.plugin(function pluginA (schema, options){

    console.log('Registering only once');

}, {

    recursive: false

});

// Register Global plugin with recursive flag set to true to use mongoose normal behavior.

// @NOTE: recursive default value is true

mongoose.plugin(function pluginB(schema, options){

    console.log('Registering only once');

}, {

    recursive: true

});

var Dummy = new mongoose.Schema({

    title: String

});

// You also can also use it directly on a schema before building the models.

Dummy.plugin(function pluginC (schema, options){

    console.log('## Something Great ##');

}, {

    recursive: true // or false

});

var DummyA = mongoose.model('DummyA', Dummy);

var DummyB = mongoose.model('DummyB', Dummy);

// Right now Dummy schema should have 1 instance of pluginA, 2 instances of pluginB and 1 instance of pluginC

```

### Tests

`npm test`

### Credits

* [Robert Hurst](https://github.com/RobertWHurst) as main thinker of this solution reported in mongoose as issue [#4106](https://github.com/Automattic/mongoose/issues/4106)