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

ams-core-entity

v0.0.4

Published

The module that defines how an entity is described and should behave.

Downloads

2

Readme

#AMS Core Entity

The module that defines how an entity is described and should behave.

##Schema

To create a model, you need to define a schema.

  var schema = new Schema({
    name:    String,
    binary:  Buffer,
    living:  Boolean,
    updated: { type: Date, default: Date.now },
    age:     { type: Number, min: 18, max: 65 },
    array:      [],
    ofString:   [String],
    ofNumber:   [Number],
    ofDates:    [Date],
    ofBoolean:  [Boolean],
    nested: {
      stuff: { type: String, lowercase: true, trim: true }
    }
  })

###Validation

If you want to validate you model, you need define how this Model should be configured.

Example:

  var vehicule = new Schema({
    name: {
      type: String,
      required: true,
    },
    tires: {
      type: Number,
      min: 1,
      max: 8
    },
    engineType: {
      type: String,
      enum: ['Electrical', 'Diesel', 'Gaz']
    },
    color: {
      type: String,
      regex: /^#?([a-f0-9]{6}|[a-f0-9]{3})$/
    }
  })

####Custom Validation

You can create custom validation for the

  var userSchema = new Schema({
    phone: {
      type: String,
      validate: {
        name: 'validatePhone',
        validator: function(v) {
          return /\d{3}-\d{3}-\d{4}/.test(v);
        },
      },
      required: true
    }
  });

####Custom Validation Async

  var userSchema = new Schema({
    phone: {
      type: String,
      validate: {
        name: 'validatePhone',
        validator: function(v, cb) {
          setTimeout(function() {
            cb(/\d{3}-\d{3}-\d{4}/.test(v));
          }, 5);
        },
      },
      required: [true, 'User phone number required']
    }
  });

####Schema

The relation between the Entities are done with the defineRelation method. It can take a 'hasMany' or a 'hasOne' relation. Nested object are object that belongs to the Entity.

Nested object that are not Entity should be defined directly in the schema. Something like { line1: '5th avenue', city: 'NYC' }.