https://github.com/mercmobily/simpleschema-mongo

Mongo driver for Simple Schema
https://github.com/mercmobily/simpleschema-mongo

Last synced: about 2 months ago
JSON representation

Mongo driver for Simple Schema

• Host: GitHub
• URL: https://github.com/mercmobily/simpleschema-mongo
• Owner: mercmobily
• License: gpl-3.0
• Created: 2013-11-17T21:53:49.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2017-04-01T02:09:21.000Z (almost 8 years ago)
• Last Synced: 2023-04-26T05:56:03.393Z (over 1 year ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
simpleschema-mongo

==================

Mongo component of the [SimpleSchema](https://github.com/mercmobily/simpleschema) module.

This module provides a "mixin" to the main SimpleSchema classes. If you "mix" this constructor class with the main SimpleSchema class, you will end up with a class able to handle Mongodb-specific fields (that is, `ObjectId` fields ).

# Driver-specific Mixins

Basic schemas work really well for any database. However, it's handy to have driver-specific schemas which take into consideration driver-specific features.

Driver-specific schemas come in the form of `mixins`: they are basic classes that should be "mixed in" with the main one. In order to mixin the constructor's prototypes, you will need to use  [SimpleDeclare - Github](https://github.com/mercmobily/simpleDeclare). See the example below on how to use it.

# Functions provided

The MongoSchemaMixin overloads objects created with the following functions:

  * `idTypeCast()` It will cast a field to Mongo's own `ObjectId` type. If the field is not valid, casting will fail

  * `makeId()` Rather than using the default id creator, which by default just returns a random number, the overloaded `makeId()` will use Mongo's own `ObjectId()` function. NOTE: `makeId()` is available as an object method, _and_ as a class method

# A practical example

Here is a practical example on how to use MongoSchemaMixin

    var Schema = require( 'simpleschema' );

    var declare = require( 'simpledeclare' );

    var MongoSchemaMixin = require('simpleschema-mongo')

    // Mixing in Schema (the basic class) with MongoSchemaMixin

    MyMongoSchema = declare( [ Schema, MongoSchemaMixin ] );

    person = new MyMongoSchema({

      personId:  { type: 'id',     required: true },

      anotherId: { type: 'id',    required: true },

      name:      { type: 'string', required: true },

    });

    var p = { name: 'Tony', anotherId: '529955ecd03de35b0f999991' } ;

    MyMongoSchema.makeId( p, function( err, id ){

      if( err ){

        console.log("Error making the id:");

        console.log( err );

      } else {

        p.personId = id;

        console.log( "MADE ID IS: ", id );

        person.validate( p, function( err, newP, errors){

          if( err ){

            console.log("Oh no!");

            console.log( err );

          } else {

            console.log("New P:");

            console.log( newP );

            console.log("Errors");

            console.log( errors);

          }

        });

      }

    });