Package Exports
- ajv
- ajv/lib/ajv
- ajv/lib/compile/equal
- ajv/lib/compile/formats
- ajv/lib/compile/formats.js
- ajv/lib/refs/json-schema-draft-04
- ajv/lib/refs/json-schema-draft-04.json
- ajv/package.json
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ajv) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ajv - Another JSON Schema Validator
One of the fastest JSON Schema validators for node.js. It uses doT templates to generate super-fast validating functions.
JSON Schema standard
ajv implements full JSON Schema draft 4 standard:
- all validation keywords
- full support of remote refs (remote schemas have to be added with
addSchemaor compiled to be available) - correct string lengths for strings with unicode pairs (can be turned off)
- formats defined by JSON Schema draft 4 standard (can be turned off)
ajv passes all the tests from JSON Schema Test Suite (apart from the one that requires that 1.0 is not an integer).
Install
npm install ajvUsage
var Ajv = require('ajv');
var ajv = Ajv(); // options can be passed
var validate = ajv.compile(schema);
var valid = validate(data);
if (!valid) console.log(validate.errors);or
// ...
var valid = ajv.validate(schema, data);
// ...or
// ...
ajv.addSchema(schema, 'mySchema');
var valid = ajv.validate('mySchema', data);
// ...ajv compiles schemas to functions and caches them in both cases (using stringified schema as a key - using json-stable-stringify), so that the next time the same schema is used (not necessarily the same object instance) it won't be compiled again.
API
Ajv(Object options) -> Object
Create ajv instance.
.compile(Object schema) -> Function
Generate validating function and cache compiled schema for future use.
.validate(Object schema|String key|String ref, data) -> Boolean
Validate data using passed schema (it will be compiled and cached).
Instead of the schema you can use the key that was previously passed to addSchema or a previously resolved reference.
.addSchema(Array schemas|Object schema [, String key]) -> Function
Add and compile schema(s). It does the same as .compile with two differences:
array of schemas can be passed (schemas should have ids), the second parameter will be ignored.
key can be passed that can be used to reference the schema and will be used as the schema id if there is no id inside the schema. If the key is not passed, the schema id will be used as the key.
Once the schema added it and all the references inside it can be referenced in other schemas and used to validate data.
In the current version all the referenced schemas should be added before the schema that uses them is compiled, so the circular references are not supported.
.getSchema(String key) -> Function
Retrieve schema previously added with addSchema. Validating function has schema property with the reference to the original schema.
Options
- allErrors: check all rules collecting all errors. Default is to return after the first error.
- verbose: include the reference to the part of the schema and validated data in errors (false by default).
- format: validate formats (true by default).
- meta: add meta-schema so it can be used by other schemas (true by default).
- uniqueItems: validate
uniqueItemskeyword (true by default). - unicode: calculate correct length of strings with unicode pairs (true by default). Pass
falseto use.lengthof strings that is faster, but gives "incorrect" lengths of strings with unicode pairs - each unicode pair is counted as two characters. - beautify: format the generated function with js-beautify (the validating function is generated without line-breaks).
npm install js-beautifyto use this option.trueor js-beautify options can be passed.
Tests
git submodule update --init
npm test