Big news!Introducing Socket AI - ChatGPT-Powered Threat Analysis.Learn more
Socket
Socket

ajv

Package Overview
Dependencies
4
Maintainers
2
Versions
350
Issues
File Explorer

Advanced tools

ajv

Another JSON Schema Validator

    8.12.0latest
    GitHub
    npm

Version published
Maintainers
2
Weekly downloads
91,645,826
increased by7.11%

Weekly downloads

Changelog

Source

v8.12.0

  • fix JTD serialisation (remove leading comma in objects with only optional properties) (#2190, @piliugin-anton)
  • empty JTD "values" schema (#2191)
  • empty object to work with JTD utility type (#2158, @erikbrinkman)
  • fix JTD "discriminator" schema for objects with more than 8 properties (#2194)
  • correctly narrow "number" type to "integer" (#2192, @JacobLey)
  • update Node.js versions in CI to 14, 16, 18 and 19

Readme

Source
Ajv logo

 

Ajv JSON schema validator

The fastest JSON validator for Node.js and browser.

Supports JSON Schema draft-04/06/07/2019-09/2020-12 (draft-04 support requires ajv-draft-04 package) and JSON Type Definition RFC8927.

build npm npm downloads Coverage Status SimpleX Gitter GitHub Sponsors

Ajv sponsors

Mozilla

Microsoft

RetoolTideliftSimpleX

Contributing

More than 100 people contributed to Ajv, and we would love to have you join the development. We welcome implementing new features that will benefit many users and ideas to improve our documentation.

Please review Contributing guidelines and Code components.

Documentation

All documentation is available on the Ajv website.

Some useful site links:

Please sponsor Ajv development

Since I asked to support Ajv development 40 people and 6 organizations contributed via GitHub and OpenCollective - this support helped receiving the MOSS grant!

Your continuing support is very important - the funds will be used to develop and maintain Ajv once the next major version is released.

Please sponsor Ajv via:

Thank you.

Open Collective sponsors

Performance

Ajv generates code to turn JSON Schemas into super-fast validation functions that are efficient for v8 optimization.

Currently Ajv is the fastest and the most standard compliant validator according to these benchmarks:

Performance of different validators by json-schema-benchmark:

performance

Features

  • Ajv implements JSON Schema draft-06/07/2019-09/2020-12 standards (draft-04 is supported in v6):
    • all validation keywords (see JSON Schema validation keywords)
    • OpenAPI extensions:
    • full support of remote references (remote schemas have to be added with addSchema or compiled to be available)
    • support of recursive references between schemas
    • correct string lengths for strings with unicode pairs
    • JSON Schema formats (with ajv-formats plugin).
    • validates schemas against meta-schema
  • NEW: supports JSON Type Definition:
    • all keywords (see JSON Type Definition schema forms)
    • meta-schema for JTD schemas
    • "union" keyword and user-defined keywords (can be used inside "metadata" member of the schema)
  • supports browsers and Node.js 10.x - current
  • asynchronous loading of referenced schemas during compilation
  • "All errors" validation mode with option allErrors
  • error messages with parameters describing error reasons to allow error message generation
  • i18n error messages support with ajv-i18n package
  • removing-additional-properties
  • assigning defaults to missing properties and items
  • coercing data to the types specified in type keywords
  • user-defined keywords
  • additional extension keywords with ajv-keywords package
  • $data reference to use values from the validated data as values for the schema keywords
  • asynchronous validation of user-defined formats and keywords

Install

To install version 8:

npm install ajv

Getting started

Try it in the Node.js REPL: https://runkit.com/npm/ajv

In JavaScript:

// or ESM/TypeScript import import Ajv from "ajv" // Node.js require: const Ajv = require("ajv") const ajv = new Ajv() // options can be passed, e.g. {allErrors: true} const schema = { type: "object", properties: { foo: {type: "integer"}, bar: {type: "string"}, }, required: ["foo"], additionalProperties: false, } const data = { foo: 1, bar: "abc", } const validate = ajv.compile(schema) const valid = validate(data) if (!valid) console.log(validate.errors)

Learn how to use Ajv and see more examples in the Guide: getting started

Changes history

See https://github.com/ajv-validator/ajv/releases

Please note: Changes in version 8.0.0

Version 7.0.0

Version 6.0.0.

Code of conduct

Please review and follow the Code of conduct.

Please report any unacceptable behaviour to ajv.validator@gmail.com - it will be reviewed by the project team.

Security contact

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerabilities via GitHub issues.

Open-source software support

Ajv is a part of Tidelift subscription - it provides a centralised support to open-source software users, in addition to the support provided by software maintainers.

License

MIT

Keywords

FAQs

Last updated on 03 Jan 2023

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
Socket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc