Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Validate JavaScript objects using JSON Schemas.
JavaScript CSS
branch: master
Failed to load latest commit information.
examples WIP
lib WIP
static Automated commit.
test Automated commit.
.gitignore WIP
.gitmodules Version 0.0.3
gruntfile.js Version 0.0.3
npm-shrinkwrap.json Automated commit.
package.json WIP
readme.md Rename Readme.md to readme.md

readme.md

The module is a wrapper for json-schema with convenience methods and improvements:

  • Does not trigger target object's getters during validation.

Module Methods

  • create( config ): Creates and returns new instance of Object Validation.
  • validate( target, schema ): Creates and returns new instance of Object Validation.
  • keys( target, schema ): Get keys to affected properties.
  • mixin( target ): Adds the prototypal methods of Object Validation to a target object.
  • set( key, value ): Set a setting to instance meta. To set default setting use 'defaults' as key.
  • get( key ): Get a meta value.

Instance Methods

Instance methods are available if the create() method was used to instantiate a new Object State.

  • validate( schema ): Validate against provided schema or default schema.
  • keys( schema ): Get array of absolute paths to property keys in current schema.

Basic Usage

The example below will trigger a failure because the tested object does not have the required "name" field.

var validate = require( 'object-validation' ).validate;

var schema = {
  name: {
    required: true
  },
  age: {
    format: "number",
    required: true
  }
}

// Will fail because missing "age"
console.log( validate({
  "name": "John Smith"
}, schema ).is_valid );

// Will validate
console.log( validate({
  "name": "John Smith",
  "age": 30
}, schema ).is_valid );

License

(The MIT License)

Copyright (c) 2013 Usability Dynamics, Inc. <info@usabilitydynamics.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.