enforcement

1.0.0 • Public • Published

Enforcement

Enforcement is yet another tool for validating your javascript object. It's minimalistic and made to be extensible

Installation

    npm install enforcement

Quickstart

    var validator = require('enforcement').create();
 
    var Person = validator.Schema({
        name: 'string',
        age: 'number'
    });
 
    var myPersonObject = {
        name: 'jeff',
        age: 22
    }
 
    Person.check(myPersonObject); // This returns undefined, but throws if validation fails;
 
    Person.validate(myPersonObject); //This returns a Folktale.js Either (http://docs.folktalejs.org/en/latest/api/data/either/Either.html);

Defining Schemas

To create a schema, use the enforcement.Schema() method. It accepts a schema definition and builds the validation.

The schema definition is a hash with the name of the fields as keys and the validations as values.

You can combine validations like the following:

    var mySchema = validator.Schema({
        aField: 'required string',
        another: ['required', 'number']
    });

You can use an array with the names of the constraints or combine them into a space separated string.

Nested Schemas

You can use schemas as validations for fields inside other schemas too. Consider you want to validate objects with the following format:

    {
        name: 'my name',
        age: 50,
        address:{
            street: 'some street',
            number 12
        }
    }

Here we want to validate a subdocument containing two fields, a string and a number. We can do this using a schema inside another, like this:

    var schema = validator.Schema({
        name: 'required string',
        age: 'positive integer',
        address: validator.Schema({
            street: 'required string',
            number: 'required positive integer'
        })
    })

Array Types

A field can be defined as an array. You can, then, define validations to run through an array field. For example, to validate an array of string that cannot be empty, you can write the following schema:

    var schema = validator.Schema({
        tags: '[string notEmpty]' //write the definition between square brackets to define that tags field is an array
    })
 
    schema.check({
        tags: ['abc', '']
    }); //this will not validate because the second string won't pass notEmpty constraint

Supported Validations

  • string
  • boolean
  • number
  • integer
  • positive
  • negative
  • notEmpty
  • required
  • array

Custom Validations

You can also create custom validations and register them into the validator:

    var greaterThanTen = {
        name: 'greaterThanTen',
        test: function(value){
            return value > 10;
        }
    }
 
    validator.register( greaterThanTen );
 
    validator.Schema({
        foo: 'integer greaterThanTen'
    })
}

It is imperative that you call register before creating any schema that uses the custom validation.

Install

npm i enforcement

DownloadsWeekly Downloads

0

Version

1.0.0

License

BSD-2-Clause

Unpacked Size

16.4 kB

Total Files

21

Last publish

Collaborators

  • jsanchesleao