ajv-error-parser

1.0.7 • Public • Published

ajv-error-parser

An error message parser for ajv schema validator errors

Methods

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

Examples

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

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)}

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'

Dependencies (0)

    Dev Dependencies (0)

      Package Sidebar

      Install

      npm i ajv-error-parser

      Weekly Downloads

      184

      Version

      1.0.7

      License

      ISC

      Unpacked Size

      18.4 kB

      Total Files

      5

      Last publish

      Collaborators

      • rrkjonnapalli