Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JSON Schema validator
JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
docs
src
tests
tools
.gitignore
.npmignore
.travis.yml
Makefile
README.md
package.json

README.md

Amanda

Build Status

Amanda validates data against JSON Schema. It's fully compliant with the JSON Schema Internet Draft.

Example

/**
 * Schema
 */
var schema = {
  type: 'object',
  properties: {
    name: {
      required: true,
      type: 'string',
      length: 7
    },
    email: {
      required: true,
      type: 'string',
      format: 'email'
    }
  }
};

/**
 * Data
 */
var data = {
  name: 'Kenneth',
  email: 'kenneth@gmail.com'
};


var JsonValidator = amanda('json');

// Validate the data against the schema
JsonValidator.validate(data, schema, function(error) {
  // Do something...
});

Features

  • Extendable, you can create your own validators
  • Can be used with Node.js and in the browser
  • Amanda has no dependencies
  • AMD compatible, you can load it via RequireJS
  • Lightweight
  • Fully documented
  • Tested

Status

Branch Status
master Build Status
dev Build Status

Contents

ExampleDownload

Download

To install Amanda, use NPM.

$ npm install amanda

Releases are available for download from GitHub.

Version Description Size Action
amanda.js uncompressed, with comments 15.06 KB (3.42 KB gzipped) Download
amanda.min.js compressed, without comments 6.2 KB (2.09 KB gzipped) Download

Usage

Browser

<script src="amanda.js"></script>

Node.js, RingoJS, Narwhal

var amanda = require('amanda');

RequireJS

// Configuration options, the path should not include the .js extension
require.config({
  paths: {
    "robb": "path/to/amanda"
  }
});

// Load Amanda
require(['amanda'], function(amanda) {

  // Do something...

});

Documentation

All documentation is available in the /docs/ folder.

Compatibility

Node.js

From version 0.6.0.

Earlier versions might work OK, but are not tested.

Browsers

Desktop

Browser Supported Version
Google Chrome 12+
Safari n/a Not tested
Firefox n/a Not tested
Opera n/a Not tested
Internet Explorer Not tested

Testing in progress...

Tests

$ npm test

Versioning

Releases will be numbered with the following format.

<major>.<minor>.<patch>

And constructed with the following guidelines.

  • Breaking backwards compatibility bumps the major
  • New additions without breaking backwards compatibility bumps the minor
  • Bug fixes and misc changes bump the patch

For more information on semantic versioning, please visit http://semver.org/.

Contributors

The following are the major contributors of Amanda (in random order).

License

(The MIT License)

Copyright (c) 2011 František Hába <hello@frantisekhaba.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.