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

mongorito-tcomb

v1.0.0

Published

Bring schema validation to Mongorito thanks to tcomb

Downloads

15

Readme


Install

npm i -S mongorito-tcomb

Usage (ES6)

// 1. Import the dependencies
import co from 'co'
import Mongorito, {Model, t} from 'mongorito-tcomb'

// 2. Let's define some Model

class User extends Model {

  // We add the optional Schema
  get Schema() {
    return t.struct({
      name: t.unique(t.String),  // name is a required String and is unique
      surname: t.maybe(t.String) // surname is an optional String
    });
  }
}

class Post extends Model {

  get Schema() {
    return t.struct({
      title: t.String,
      content: t.String,
      author: t.ID(User) // Here we set the id of the author
    });
  }

}

co(function *(val) {

  // 3. Connect the database
  yield Mongorito.connect('localhost/mongo-tcomb-playground');


  // 4. Remove all users (for examples purpose)
  yield User.remove()

  // 5. Save a valid Model
  var valid = new User({name: 'Valid'});
  yield valid.save();

  // 6. Try to save an invalid Model
  var invalid = new User({name: 'Invalid', surname: 88});
  try {
    yield invalid.save();
  } catch (e) {
    console.log(e); // An exception is throw here
  }

  // 7. You can't create a new user with the same name
  var sameName = new User({name: 'Valid', surname: 'But not unique' });
  try {
    yield sameName.save();
  } catch (e) {
    console.log(e); // An exception is throw here
  }

  // 8. Let's now create a Post
  var post = new Post({
    title: 'Hello',
    content: 'Lorem Ipsum...',
    author: "" + valid.get('_id')
  });

  yield post.save();

  // 9. You can't save post with invalid IDs
  post.set('author', 'I want to be an ID...');

  try {
    yield post.save();
  } catch (e) {
    console.log(e); // An exception is throw here
  }


  // 10. And you can't save post with an ID which is not an User
  post.set('author', '' + post.get('_id'));

  try {
    yield post.save();
  } catch (e) {
    console.log(e); // An exception is throw here
  }

  // 11. Don't forget to disconnect Mongorito
  yield Mongorito.disconnect();
});

For coffeescript, you can see examples

API

Mixins

patch: (Model) -> PatchedModel

The patch function can be useful to combine different Mongorito plugins. It take a class, extend it then return the extended class.

Customs tcomb types

t.unique

It ensure that the type is unique in the database.
Usage: t.unique(T) where T is any tcomb type

t.ID

It represent the ID of an element in the database.
Usage: t.ID(M) where M is a Mongorito model
It ensure that ID is valid and exist in the database

TODOS

  • [ ] More human exceptions