Validator

Validation

Instances of this class represent a single validation and provide various methods for validating its value.

middleware(next, app) ⇒ function

Middleware to validate requests. Depending on the request method it automatically decides if it uses req.queryParams (default) or req.postParams (only for POST and PUT). The validator requires the params middleware to be configured.

Kind: global class

• Validator
  • new Validator(objectToValidate)
  • .validate(key, trim) ⇒ Validation
  • .hasUnvalidatedProperties() ⇒ boolean
  • .validateAll(key, trim) ⇒ Validation
  • .hasFailures(name) ⇒ boolean
  • .getMessages(key) ⇒ Array | Object
  • .getValue(key) ⇒
  • .getValues() ⇒ Object

Creates a new Validator instance. Validator instances provide the functionality to validate values and collect messages explaining eventually occurred failures.

Returns: Validator - A newly created validator instance

Example

let validator = new Validator({
  "email": "[email protected]"
});

// validate a value
validator.validate("email").
         isDefined("Email address is missing!").
         isEmail("Invalid email address provided");

// returns true if a validation failed
validator.hasFailures();

// returns an object with all failure messages
validator.getMessages();

Main validation entry point. The result of this method contains various validation functions that can be chained. Note that this validation object stops validating at the first fail.

Kind: instance method of Validator
Returns: Validation - A Validation instance
See: #Validator.prototype.validateAll

Checks if all properties of the given object have been validated.

Kind: instance method of Validator
Returns: boolean - true, if all properties had a validation; false otherwise
Example

let validator = new Validator({
  "email": "[email protected]",
  "additional_key": "value"
});

// validate a value
validator.validate("email").
         isDefined("Email address is missing!").
         isEmail("Invalid email address provided");

// returns false, since the email is valid
validator.hasFailures();

// but: returns true since additional_key has no validation
validator.hasUnvalidatedProperties();

Main validation entry point. The result of this method contains various validation functions that can be chained. Note that this validation object does not stop at the first fail but continues to validate all validation functions.

Kind: instance method of Validator
Returns: Validation - A Validation instance
See: #Validator.prototype.validate

Returns true if any of the validations of this validator failed

Kind: instance method of Validator
Returns: boolean - True if any (or the specified value) validation failed

Returns either an array with the messages for a given key, or an object with the validation names as keys and the according message array as value.

Kind: instance method of Validator
Returns: Array | Object - The messages

Returns the value for a validation.

Kind: instance method of Validator
Returns: The correspondending value for a validation

Returns the values of all validations

Kind: instance method of Validator
Returns: Object - An object containing all validation values

Instances of this class represent a single validation and provide various methods for validating its value.

Kind: global class

• Validation
  • new Validation(validation, stopOnFail)
  • .hasLength(length, message) ⇒ Validation
  • .hasLengthBetween(minLength, maxLength, message) ⇒ Validation
  • .hasMaxLength(maxLength, message) ⇒ Validation
  • .hasMinLength(minLength, message) ⇒ Validation
  • .hasValue(message) ⇒ Validation
  • .isAlpha(message) ⇒ Validation
  • .isAlphanumeric(message) ⇒ Validation
  • .isDateFormat(message) ⇒ Validation
  • .isDefined(message) ⇒ Validation
  • .isEmail(message) ⇒ Validation
  • .isEqual(obj, message) ⇒ Validation
  • .isFalse(message) ⇒ Validation
  • .isFileName(message) ⇒ Validation
  • .isFloat(message) ⇒ Validation
  • .isGreaterThan(right, message) ⇒ Validation
  • .isHexColor(message) ⇒ Validation
  • .isInt(message) ⇒ Validation
  • .isLessThan(right, message) ⇒ Validation
  • .isNaN(message) ⇒ Validation
  • .isNotNaN(message) ⇒ Validation
  • .isNull(message) ⇒ Validation
  • .isNotNull(message) ⇒ Validation
  • .isNumeric(message) ⇒ Validation
  • .isNumber(message) ⇒ Validation
  • .isStrictEqual(obj, message) ⇒ Validation
  • .isStrictNotNull(message) ⇒ Validation
  • .isStrictNull(message) ⇒ Validation
  • .isString(message) ⇒ Validation
  • .isTrue(message) ⇒ Validation
  • .isUrl(message) ⇒ Validation
  • .matches(regex, message) ⇒ Validation
  • .optional(defaultValue, strict) ⇒ Validation
  • .passes(func, message) ⇒ Validation
  • .toBoolean(strictTrue) ⇒ Validation
  • .toDate(format, locale, timezone, lenient) ⇒ Validation
  • .toFloat() ⇒ Validation
  • .toInt() ⇒ Validation
  • .toValue(converter) ⇒ Validation
  • .getValue() ⇒

Returns: Validation - A newly created validation instance

Passes if the value has the given length.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value's length is between the minLength and maxLength.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value's length is not longer than maxLength.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value's length is not shorter than minLength.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is not undefined, not null or the not empty string.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is alphabetic.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value contains only letters of the alphabet and numbers.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid date format pattern.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is not undefined.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid email address.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is equal to the given object.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is false.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value contains no characters that are forbidden in file names.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid floating point string literal or of type Number with a remainder.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is greater than the given number: value > right

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid color value in hexadecimal format. It may also contain # as first character.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid integer string literal or Number.isSafeInteger(value) returns true.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is less than the given number: value < right

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is NaN.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is not NaN.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is null.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is not null.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value contains only the characters [0-9] or is of type number.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid floating point or integer string literal.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is strict equal to the given object.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is strict not null.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is strict null.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a string.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is true.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value is a valid URL.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the value matched the given regular expression.

Kind: instance method of Validation
Returns: Validation - This validation instance

Marks the validation of a key as optional. If provided and if a key is not defined or its value is falsy, the validation's value will be replaced with the defaultValue.

Kind: instance method of Validation
Returns: Validation - This validation instance

Passes if the given function returns true. The function receives the value as first argument.

Kind: instance method of Validation
Returns: Validation - This validation instance

Converts the value to a boolean.

Kind: instance method of Validation
Returns: Validation - This validation instance

Converts the value to a Date object or NaN if parsing failed.

Kind: instance method of Validation
Returns: Validation - This validation instance

Converts the value to a floating point number or NaN if if parsing failed.

Kind: instance method of Validation
Returns: Validation - This validation instance

Converts the value to an integer number or NaN if if parsing failed.

Kind: instance method of Validation
Returns: Validation - This validation instance

Converts the value with the given function.

Kind: instance method of Validation
Returns: Validation - This validation instance

Returns the value of the validation.

Kind: instance method of Validation
Returns: Current value of the validation

Middleware to validate requests. Depending on the request method it automatically decides if it uses req.queryParams (default) or req.postParams (only for POST and PUT). The validator requires the params middleware to be configured.

Kind: global function
Returns: function - a JSGI middleware function

Example

app.configure("params", require("validator"), "route");

app.get("/", function(req) {

  req.validate("countryCode", true)
     .hasLength(3, "Invalid country code!");

  req.validate("email")
     .isDefined("Email missing!")
     .isEmail("Invalid email!");

  if (req.hasFailures()) {
    return response.html(req.failureMessages().join("<br>"));
  }

  return response.html("Ok");
});