npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

formal-mongoose

v0.3.0

Published

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

Downloads

6

Readme

Formal-mongoose Build Status Coverage Status Dependency Status

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

Example

var Form = require('formal-mongoose'),
    model = mongoose.model('User');

var form = new Form(model, ['name.*', 'email']);

form.field({
  tos: {
    type: Boolean,
    default: false,
    validate: function(val) {
      return val === true;
    }
  }
});

form.set({
  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é
  console.log(form.export());
});

Install

npm install formal-mongoose --save

Summary

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

API

For the inherited prototype see the Formal API.

new Form(schema:Object|String, fields:Array, options:Object):instance

schema mongoose model or schema or the model name
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.

app.post('/url',
  // sames as (new Form({...})).middleware()
  form(schema, ['username', 'password']),
  function (req, res) {
    console.log(req.form.data);
    console.log(res.locals.form.username.value);
  }
);

form.addPath(path:String):void

Add a path from the schema.

Notes:

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

// to import name.firstname and name.lastname
form.addPath('name.*')

Test

npm test
Mocha Coverage
npm run-script coverage
On Coveralls.io

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

LICENSE

MIT