README.md

JCVD

Javascript Can Validate Data

This package lets you validate nested types at runtime, giving you error messages showing the path of the property that had the error. Build up the types using predicates like those found in check-types or prettycats. You can also create your own predicates.

const {
        isObjectOf,
        isArrayOf,
        isOptional,
        isRequired
      } = require('jcvd');

const isString = isRequired(n => typeof n === 'string');
const isNumber = isRequired(n => typeof n === 'number');

const isAddress = isObjectOf({
  street      : isString,
  houseNumber : isNumber
});

const isMyType = isObjectOf({
  foo       : isOptional(isString),
  bar       : isNumber,
  arr       : isArrayOf(isNumber),
  addresses : isOptional(isArrayOf(isAddress))
});

const isMyOtherType = isObjectOf({
  baz    : isString,
  myType : isMyType
});

isMyOtherType({
  baz    : 'dop',
  myType : {
    foo       : 'derp',
    bar       : 3,
    arr       : [3, 3],
    addresses : [
      {
        street      : 'penny lane',
        houseNumber : '13' // <- this property should be a number
      }
    ]
  }
});

// Will throw: 'myType addresses [0] houseNumber invalid'

Custom error handlers

You can give this package an object with custom error handlers for missing and invalid errors.

const {
        isObjectOf,
        isArrayOf,
        isRequired
      } = customErrors({
  handleInvalid : () => {
    return new Error('dang');
  },
  handleMissing : () => {
    return new Error('crap');
  }
});

const isString = isRequired(n => typeof n === 'string');

const isAwesomeCar = isObjectOf({
  whales : isArrayOf(isString)
});

isAwesomeCar({
  whales : ['beluga', 3] // <- 3 is not a string
});

// Will throw: 'whales [1] dang'

CHANGELOG

• 1.0.0 - initial commit
• 1.0.1 - fork from nested-validate with the latest improvements
• 1.0.2 - update tests
• 1.0.3 - return true for passing isArrayOf
• 1.0.4 - update readme
• 1.0.5 - make isOptional consider both null and undefined as missing
• 1.1.0 - label now returns value instead of true for tap flow
• 1.1.1 - clean code semantics
• 1.1.2 - change map to forEach in getOwnPropertyNames
• 1.1.3 - update readme
• 1.1.4 - make isRequired consider both null and undefined as missing