ajv-error-messages

Normalise AJV error messages

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ajv-error-messages
1102.1.010 months ago6 years agoMinified + gzip package size for ajv-error-messages in KB

Readme

ajv-error-messages
Normalise errors from ajv to a simpler format.
Takes ajv errors and returns a simpler object. Inspired by https://github.com/MauriceButler/jayschema-error-messages
AJV Version
v2 of ajv-error-messages has been upgraded to work with v8 of ajv

Usage

var normalise = require('ajv-error-messages');
var SchemaValidator = require('ajv');
var schemaValidator = SchemaValidator({ allErrors: true });

var schema = {
    description: 'test schema',
    type: 'object',
    additionalProperties: false,
    required: ['foo'],
    properties: {
        foo: {
            type: 'string',
        },
    },
};
var invalidData = {
    foo: 2,
};

var validator = schemaValidator.compile(schema);

function validatingData(data) {

    var valid = validator(data);
    var normalisedErrors;
    if (!valid) {
        var ajvErrors = validator.errors
        normalisedErrors = normalise(ajvErrors);
    }

    return valid || normalisedErrors;
}

console.log(JSON.stringify(validatingData(invalidData)));

results in
{
    fields: {
        'foo': ['Must be string']
    }
}