1.0.0 • Published 7 years ago

vtypes-requiredwith v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

vtypes-requiredwith

"Required With" validator for validate.js

npm package vtypes

About

The requiredWith validator attempts to ensure that the input is be present and not empty if ANY of the other specified fields are present.

Installation

Using npm:

$ npm i --save vtypes-requiredwith
const validate = require('validate.js');
const requiredWith = require('vtypes-requiredwith');

// you can then proceed to register the required validators.
validate.validators.requiredWith = requiredWith;

Usage

const constraint = {
  attr: {
    requiredWith: {attributes: ['other']}
  }
}

validate({}, constraint);
// => undefined

validate({attr: 'foo', other: 'bar'}, constraint);
// => undefined

validate({other: 'bar'}, constraint);
// => {attr: ['Attr is required when any of these attributes (other) are present']}

For more examples, check out the test files in this package's source folder.

Available Options

nametypedefaultdescription
attributesarrayThe list of attributes
messagestringis required when any of these attributes (%{attributes}) are presentError message
truthybooleanfalseChecks for truthy values instead of checking only for null and undefined values

License

vtypes-requiredwith is MIT licensed