# ajv-error-parser

> A proper error message parser for ajv schema validator errors

Latest version **1.0.7** (published 2019-05-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install ajv-error-parser
pnpm add ajv-error-parser
yarn add ajv-error-parser
bun add ajv-error-parser
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-05-07 |
| First published | 2019-04-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | rrkjonnapalli |
| Maintainers | rrkjonnapalli |
| Keywords | ajv, ajv-errors, ajv-error, ajv-error-parser |

## Links

- npm: https://www.npmjs.com/package/ajv-error-parser
- Repository: https://github.com/rrkjonnapalli/ajv-error-parser
- Homepage: https://github.com/rrkjonnapalli/ajv-error-parser#readme
- Issues: https://github.com/rrkjonnapalli/ajv-error-parser/issues
- npm.io page: https://npm.io/package/ajv-error-parser

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2019-05-07
- 1.0.6 — 2019-04-29
- 1.0.5 — 2019-04-26
- 1.0.4 — 2019-04-26
- 1.0.3 — 2019-04-26
- 1.0.2 — 2019-04-26
- 1.0.1 — 2019-04-26
- 1.0.0 — 2019-04-26

## README

# ajv-error-parser
An error message parser for ajv schema validator errors

## Methods
```javascript
parseErrors(errors, opts)
opts:
    json: boolean // default true
    delimiter: string // default '\n' used only if json=false
```



## Examples

```javascript
const AJVErrorParser = require('ajv-error-parser');
const errors = [
    {
        keyword: 'additionalProperties',
        dataPath: '.foo',
        schemaPath: '#/oneOf/0/additionalProperties',
        params: { additionalProperty: 'k' },
        message: 'should NOT have additional properties',
        schema: false,
        parentSchema:
        {
            properties: [Object],
            required: [Array],
            additionalProperties: false
        },
        data: { k: 1 }
    },
    {
        keyword: 'required',
        dataPath: '',
        schemaPath: '#/oneOf/0/required',
        params: { missingProperty: 'foo' },
        message: 'should have required property \'foo\'',
        schema: { foo: [Object] },
        parentSchema:
        {
            properties: [Object],
            required: [Array],
            additionalProperties: false
        },
        data: { k: 1 }
    }
];
const messages = AJVErrorParser.parseErrors(errors)
console.log(messages)

// OUTPUT:
[
  'should not have additional properties \'k\' in foo',
  'should have required property \'foo\'' 
]
```

### json

```javascript
const messages = AJVErrorParser.parseErrors(errors, {json: false})
console.log(messages)

//OUTPUT:

should not have additional properties 'k' in foo
should have required property 'foo'
```


### delimiter
It is the string to join messages

>Syntax:
>
> {delimiter}{messages.join(delimiter)}

```javascript
const messages = AJVErrorParser.parseErrors(errors, {
    json: false,
    delimiter:'\n<br/><b>Message:</b>'
})
console.log(messages)

//OUTPUT:

<br/><b>Message:</b>should not have additional properties 'k' in foo
<br/><b>Message:</b>should have required property 'foo'
```

---
_Source: https://npm.io/package/ajv-error-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._