valour

Valour

Simple javascript validation for any app.

Usage

Self-managed

var valour = require('valour');
var result;

valour.register('formName', {
  'email': valour.rule.isRequired()
                     .isEmail()
                     .isValidatedBy(function (value) {
                       var disallowedNames = ['[e-mail]', '[e-mail]', '[e-mail]'];
                       return disallowedNames.indexOf(value) === -1;
                     }, 'This email is not allowed')
                     .equalsOther('confirmEmail')
                     .isValidatedBy(function (value, allValues) {
                       return allValues.otherAddresses.indexOf(value) === -1;
                     }, 'The {name} field cannot be in your other addresses.')
 }, function (res) {
  result = res;
 });

valour.runValidation('formName', { email: '[e-mail]' });
// result === { 'email': {valid: true} }

valour.forceValidation('formName', {});
// result === {'email': {valid: false, messages: ['email is required.']}}
valour.runValidation('formName', { email: 'notanemail' });
// result === { 'email': {valid: false, messages: ['email must be a valid email address']} }
valour.runValidation('formName', { email: '[e-mail]' });
// result === { 'email': {valid: false, messages: ['This email is not allowed']} }
valour.runValidation('formName', { email: '[e-mail]', confirmEmail: '[e-mail]' });
// result === { 'email': {valid: false, messages: ['The email field cannot be in your other addresses.']} }

NOTE:

An important distinction here is the difference between runValidation and forceValidation. runValidation is something you would use as things update (like in a change event for an input), and forceValidation is what you would use when you wanted to check all fields (like in a submit event). runValidation does not check undefined values, but forceValidation will. This is because, most of the time, you don't want your UI to falsely report to the user when they haven't yet put any data into a required field.

Async validation

var valour = require('valour');
var resolve, reject, result;

function resolveResult() {
  resolve();
}

function rejectResult() {
  resolve();
}

valour.register('formName', {
  'email': valour.rule.isEventuallyValidatedBy(
    function (value, allValues, resolve, reject) {
      resolve = resolve;
      reject = reject;
    });
  }, function (res) {
    result = res;
  });

valour.runValidation('formName', { email: '[e-mail]' });
// result === { 'email': { waiting: true }}

resolveResult();
// result === { 'email': { valid: true }}

valour.runValidation('formName', { email: '[e-mail]' });
// result === { 'email': { waiting: true }}

rejectResult();
valour.runValidation('formName', { email: '[e-mail]' });
// result === { 'email': { valid: false }}