node package manager


formal + mongoose = DRY! Define your form from your mongoose schema.


Formal + Mongoose = DRY! Simple solution to define a form with validation (and more) from a mongoose schema.

var Form = require('formal-mongoose'),
    model = mongoose.model('User');
var form = new Form(model, ['name.*', 'email']);
  tos: {
    type: Boolean,
    default: false,
    validate: function(val) {
      return val === true;
  name: {family: 'Martinez'},
  'name.first': 'José Luis Chavez',
  age: 12,
  tos: true
form.validate(function (err) {
  console.log(err); // missing required email, age to low 
  console.log(form.get('name.first.0')); // José 

npm install formal-mongoose --save

Extend formal to provides fast and easy way to define a form from an existing schema. The best way to don't repeat yourself!

For the inherited prototype see the Formal API.

schema mongoose schema or model
fields array of strings path to import from the mongoose schema
options object of options identical to Formal

var Form = require('formal-mongoose');
var form = new Form(mongoose.model('User'), ['username', 'pasword']);

For connect and express the alternative factory method can be used as a quick helper to create a new instance and return form.middleware() to monkey patch the request and response object.'/url',
  // sames as (new Form({...})).middleware() 
  form(schema, ['username', 'password']),
  function (req, res) {

Add a path from the schema.

Allows path to end with a wildcard * to import direct children example:

// to import name.firstname and name.lastname 

npm test
Mocha Coverage npm run-script coverage

All tests are in Coffee-script, hence easy to read! Provides a great way to understand the API ;)