Skip to content
This repository

JSON Schema validator

tag: v0.4.3

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 docs
Octocat-spinner-32 releases
Octocat-spinner-32 src
Octocat-spinner-32 tests
Octocat-spinner-32 tools Minor improvements to the build system March 15, 2012
Octocat-spinner-32 .gitignore Initial commit November 14, 2011
Octocat-spinner-32 .npmignore Updated the ‘.npmignore’ file March 07, 2012
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 LICENSE Add the ‘LICENSE’ file December 26, 2012
Octocat-spinner-32 Makefile
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
README.md

Amanda

Amanda is aiming to be a universal schema validation library. Currently it supports only the JSON Schema Internet Draft, but I'm planning to add Orderly, Relax NG and others very soon.

Example

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

/**
 * Data
 */
var data = {
  name: 'Kenneth'
};

// Initialize a JSON Schema validator.
var jsonSchemaValidator = amanda('json');

// Validate the data against the schema.
jsonSchemaValidator.validate(data, schema, function(error) {

  // Do something...

});

Contents

Features

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

Download

Node.js

To install Amanda, use NPM.

$ npm install amanda

Then you can load the library via require.

var amanda = require('amanda');

If you prefer RequireJS, go ahead.

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

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

  // Do something...

});

Browser

Releases for the browser are available for download from GitHub.

Version Description Size Action
amanda.js uncompressed, with comments 36.01 KB (7.11 KB gzipped) Download
amanda.min.js compressed, without comments 13.62 KB (3.99 KB gzipped) Download

Or you can use JAM.

$ jam install amanda

Then you can load the library via the <script> tag.

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

...or via RequireJS.

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

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

  // Do something...

});

Status

Branch Status
master Build Status
dev Build Status

Documentation

All documentation is available in the /docs/ folder.

Compatibility

Node.js

From version 0.6.0.

Browsers

Testing in progress...

Building

I have included a Makefile with convenience methods for working with the library.

  • make Builds the library

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/.

Release Notes

Authors

František Hába (@Baggz) created Amanda and these people have contributed.

License

Please see the LICENSE file.

Something went wrong with that request. Please try again.