Installations

npm install @stoplight/better-ajv-errors

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Min. Node Version

^12.20 || >= 14.13

Node Version

16.17.0

NPM Version

8.15.0 Score

98.8

Supply Chain

95.8

Quality

75.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

9

Closed

1

Merged

4

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

54

Unable to fetch Contributors

View all 54 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

stoplightio

Download Statistics

Total Downloads

62,956,992

Last Day

141,219

Last Week

614,818

Last Month

2,588,114

Last Year

31,874,389

GitHub Statistics

2 Stars

103 Commits

3 Forks

2 Watching

11 Branches

54 Contributors

Bundle Size

5.51 kB

Minified

2.20 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

1.0.3

Package Id

@stoplight/better-ajv-errors@1.0.3

Unpacked Size

31.06 kB

Size

5.29 kB

File Count

7

NPM Version

8.15.0

Node Version

16.17.0

Total Downloads

Cumulative downloads

Total Downloads

62,956,992

Last day

-0.8%

141,219

Compared to previous day

Last week

-11.9%

614,818

Compared to previous week

Last month

4.4%

2,588,114

Compared to previous month

Last year

67.6%

31,874,389

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

jsonpointer leven

Peer Dependencies

1

ajv

Dev Dependencies

16

@babel/core @babel/preset-env ajv babel-jest dotenv eslint eslint-config-prettier eslint-plugin-jest eslint-plugin-prettier flow-bin husky jest jest-fixtures prettier pretty-quick rollup

Versions

JSON Schema validation for Human 👨‍🎤

Main goal of this library is to provide relevant AJV error messages. It's a fork of great better-ajv-errors by Atlassian, with focus on being leaner.

Installation

1$ yarn add @stoplight/better-ajv-errors

or

1$ npm i @stoplight/better-ajv-errors

Also make sure that you installed ajv package to validate data against JSON schemas.

Usage

First, you need to validate your payload with ajv. If it's invalid then you can pass validate.errors object into better-ajv-errors.

1import Ajv from 'ajv';
2import betterAjvErrors from '@stoplight/better-ajv-errors';
3// const Ajv = require('ajv');
4// const betterAjvErrors = require('better-ajv-errors');
5
6// You need to pass `jsonPointers: true`
7const ajv = new Ajv({ jsonPointers: true });
8
9// Load schema and data
10const schema = ...;
11const data = ...;
12
13const validate = ajv.compile(schema);
14const valid = validate(data);
15
16if (!valid) {
17  const output = betterAjvErrors(schema, validate.errors, {
18    propertyPath: [],
19    targetValue: data,
20  });
21  console.log(output);
22}

API

betterAjvErrors(schema, data, errors, [options])

Returns formatted validation error to print in console. See options.format for further details.

schema

Type: Object

The JSON Schema you used for validation with ajv.

errors

Type: Array

Array of ajv validation errors

options

Type: Object

propertyPath

Type: Array

Property path of a validated object that is a part of a bigger document. Might be empty if the validated object equals the whole document.

targetValue

Type: Object

The JSON payload you validate against using ajv.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.9

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More