js-data-validator

Data validator and normalizer

Introduction

Important Note: This is work in progress. Please, don't use it in production yet.

This work is inspired by the awesome joi object schema validator.

Why another validation module? Error messages! When validating incoming data data in an API endpoint, we would like to inform clients with custom meaningful messages describing what's wrong with there requests. There is no way to do that with joi.

Example

const Jdv = require('js-data-validator');

const schema = Jdv.object().keys({
  userName: Jdv.string().required('my custom error message about missing "userName"'),
  password: Jdv.string().required('my custom error message about missing "password"')
                        .notEmpty('my custom error message about empty "password"'),
  avatarUrl: Jdv.string().defaultsTo('http://example.com/avatars/default')
});

const incomingData = {
  userName: 'John Smith'
};

const { data, errors } = Jdv.validate(schema, incomingData);

if (errors.length) {
  res.status(400).json({ errorMessages: errors.join(', ')});
  return;
}

// Here start using data

API Reference

• Jdv
  • validate(schema, data)
  • object()
    • object.keys(obj)
      • object.key.required([msg])
      • object.key.defaultsTo([value])
  • array({ [schema], [msg] })
    • array.notEmpty([msg])
  • string()
    • string.notEmpty([msg])
  • integer([msg])
    • integer.max(value, [msg])
    • integer.min(value, [msg])
  • boolean()

Jdv

validate(schema, data)

Validates data against schema and returns normalized data if the schema prescribes doing it. The method doesn't mutate passed data.

• schema {Object} - validation schema.

• data {Any} - data to be validated and normalized.

Returns Object with properties:

• data {Any} - normalized data.

• errors {Array<String>} - collection of error messages.

object()

Generates a schema to validate/normalize an object.

object.keys(obj)

Defines validation rules for object properties.

• obj {Object} - Object where each key is assigned a validation schema.

object.key.required([msg])

Creates validation rule for a key to be present in the object.

• msg {String} - Optional error message. Defaults to an empty string.

object.key.defaultsTo([value])

Creates normalization rule for a missing property in the data object to be set to the specified value.

• value {Any} - Optional. Value to be assigned to the missing property. Defaults to null.

array({ [schema], [msg] })

Generates a schema to validate/normalize an array.

• opts {Object} - Optional. Options:

  • schema {Object} - Optional. Validation schema to be applied to each element of the array. If no schema passed, the array elements are not validated/normalized.

  • msg {String} - Optional. Error message to be included in the returned errors collection in case the passed data is not an array. Defaults to an empty string.

Example:

const schema = Jdv.object().keys({
  userNames: Jdv.array({
    schema: Jdv.string().notEmpty('my custom error message'),
    msg: 'my custom error message for the case "userNames" is not an array'
  }).notEmpty('my custom error message for the case "userNames" is an empty array')
});

array.notEmpty([msg])

Creates validation rule for not allowing the array to be empty.

• msg {String} - Optional error message. Defaults to an empty string.

string()

Generates a schema to validate/normalize a string.

Any validated value is coerced to a string using String() constructor function.

string.notEmpty([msg])

Creates validation rule for not allowing the string to be empty.

• msg {String} - Optional error message. Defaults to an empty string.

integer([msg])

Generates a schema to validate/normalize an integer value.

Any validated value is tried to be parsed into an integer.

• msg {String} - Optional error message. Defaults to an empty string.

Example:

const schema = Jdv.integer('my custom error message in case the value is not an integer')
                  .max(100, 'my custom error message in case it is greater')
                  .max(0, 'my custom error message in case it is less');
});

integer.max(value, [msg])

Creates validation rule for a value to be less or equal to the passed maximum value.

• value {Integer} - Maximum value to compare with.

• msg {String} - Optional error message. Defaults to an empty string.

integer.min(value, [msg])

Creates validation rule for a value to be greater or equal to the passed minimum value.

• value {Integer} - Minimum value to compare with.

• msg {String} - Optional error message. Defaults to an empty string.

boolean()

Generates a schema to validate/normalize a boolean value.

Any validated value is coerced to a string using Boolean() constructor function.