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

simpleschema-mongo

v0.3.15

Published

Mongo component for the simpleschema module

Downloads

9

Readme

simpleschema-mongo

Mongo component of the 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. 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);
      }
    });
  }
});