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

mongoose-schemagen

v2.3.3

Published

Exceptionally featureful RESTful web services middleware for Connect.

Downloads

79

Readme

NPM

js-standard-style

mongoose-schemagen is a very small utility library allowing to generate validable mongoose schemas from pure JS objects.

Features:

  • generates mongoose schema by a JS object
  • generates model
  • extends model's save function with validation
  • support indexing, unique constraint and value encryption
  • instance and static Model functions

By using this library, you will be free from the load of schema and model creation and every record you might want to create and store will be validated against the rules passed by. Use it well! :)

In the example, the rules follow the syntax of Vindication.js which is a great library to be used on both client and server side for validation.

This project is designed to support complex business models shared between client and server-side opening the code for the sharing of model, validation and computation functions.

License: MIT

##Usage

// require the lib
let schemagen = require('mongoose-schemagen')
// require the lib which can iterpret the validation rules. vindication.js is used in this example.
let vindication = require('vindication.js')

// have a prototype model. The business logic object will look like this.
let prototype = {
	password: {
		_type: String,
		_encrypted: true
	},
	uid: { _type: String, _unique: true },
	firstName: 'Planet',
	lastName: 'Earth',
	fullName: function() {
		return this.firstName() + ' ' + this.lastName()
	}
}


// define some rules as validation constraints
let rules = {
	firstName: { required: true, type: 'number' },
	lastName: { minlength: '1', type: 'alphanum' }
}

// create schema and model. The returning object possesses the mongoose model and the schema as well.
let gen = schemagen.generate(
	prototype,
	{
		firstName: { required: true, type: 'number' },
		lastName: { minlength: '1', type: 'alphanum' }
	},
	{ collection: 'Docs' },
	{ name: 'Doc', validator: vindication.validate }
)
let model = gen.model

// create a mongoose record by some JS object
let record = new model( prototype )

// save the record with validation. In case of validation issues, an Error will be thrown.
record.save()

And that's it!