Ajv: Another JSON Schema Validator

Ajv v7 beta is released

Mozilla MOSS grant and OpenJS Foundation

Please sponsor Ajv development

Open Collective sponsors

Using version 6

Contents

Performance

Features

Install

Getting started

Using in browser

Ajv and Content Security Policies (CSP)

Command line interface

Validation keywords

Annotation keywords

Formats

Combining schemas with $ref

$data reference

$merge and $patch keywords

Defining custom keywords

Asynchronous schema compilation

Asynchronous validation

Using transpilers with asynchronous validation functions.

Using nodent

Using other transpilers

Security considerations

Security contact

Untrusted schemas

Circular references in JavaScript objects

Security risks of trusted schemas

Content Security Policies (CSP)

ReDoS attack

Filtering data

Assigning defaults

Coercing data types

API

new Ajv(Object options) -> Object

.compile(Object schema) -> Function

.compileAsync(Object schema [, Boolean meta] [, Function callback]) -> Promise

.validate(Object schema|String key|String ref, data) -> Boolean

.addSchema(Array|Object schema [, String key]) -> Ajv

.addMetaSchema(Array|Object schema [, String key]) -> Ajv

.validateSchema(Object schema) -> Boolean

.getSchema(String key) -> Function

.removeSchema([Object schema|String key|String ref|RegExp pattern]) -> Ajv

.addFormat(String name, String|RegExp|Function|Object format) -> Ajv

.addKeyword(String keyword, Object definition) -> Ajv

.getKeyword(String keyword) -> Object|Boolean

.removeKeyword(String keyword) -> Ajv

.errorsText([Array errors [, Object options]]) -> String

Options

Validation and reporting options

Referenced schema options

Options to modify validated data

Strict mode options

Asynchronous validation options

Advanced options

Validation errors

Error objects

Error parameters

Error logging

Plugins

Related packages

Some packages using Ajv

Tests

Contributing

Changes history

Code of conduct

Open-source software support

License