mongoose-mass-assign

A mongoose plugin to help safely perform mass assignments from web input

npm install mongoose-mass-assign
4 downloads in the last day
43 downloads in the last week
104 downloads in the last month

mongoose-mass-assign

This plugin provides two functions called #massAssign to your models. One static and one instance. You can use these to protect specific fields from web input. The plugin adds the schematype option 'protect' so you don't have to write any filtering code.

You can also get direct access to the filtering mechanism through the static massUpdate.

Install

npm install mongoose-mass-assign

Current version 0.3.0

Usage

Defining:

var massAssign = require('mongoose-mass-assign');

var UserSchema = new mongoose.Schema({
  name      : String,
  admin     : { type: Boolean, protect: true, default: false },
  verified  : { type: Boolean, protect: true, default: false }
});

UserSchema.plugin(massAssign);

var User = mongoose.model('User', UserSchema);

Using:


/** Static method, useful for creation **/

var user = User.massAssign({
  name: 'bhelx',
  admin: true
});

// user => { name: 'bhelx', admin: false, verified: false }

/** Instance method, useful for updating  **/
var user = new User;

user.massAssign({
  name: 'bhelx',
  admin: true
});

// user => { name: 'bhelx', admin: false, verified: false }

/** Static massUpdate method **/
var input = { name: 'bhelx', admin: 'true' };

User.update({ '_id': someId }, { $set: User.massUpdate(input) }, console.log);

For more details see test.js

Testing

npm install
make test
npm loves you