validator-lib

0.0.8 • Public • Published

Validator-lib

Validations for objects. Can be used to validate form inputs and such. Doc is WIP.

Installation

npm install validator-lib

How to use

import Validator from "validator-lib";
 
var data = {
  person: {
    firstName: "Ronald",
    lastName: "Dump"
  },
  address: {
    street: "",
    houseNumber: null
  }
}
 
var rules = [
  {
    validator: "required",
    fields: [ "person.firstName", "person.lastName" ],
    message: "First and/or last name are required"
  },
  {
    validator: "required",
    fields: [ "address.street"],
    message: "Street is required"
  },
  {
    validator: "number",
    fields: [ "address.houseNumber" ],
    message: "House number must be a number",
    allowBlank: true
  }
];
 
validator = new Validator(rules, data);
validator.validate();

Rule options

  • validator: One of the built in validators:
    • required
    • number
      • gt: > number
      • gte: >= number
      • lt: < number
      • lte: <= number
    • length
      • gt: > length
      • gte: >= length
      • lt: < length
      • lte: <= length
    • format
    • email
    • custom
      • validation: custom validation function
  • fields: Determines which fields should be validated in this rule
  • message: The error message for the fields when validation fails
  • if: Contains function that determines if the rule should be ran
  • on: Only runs rule when the given event matches
  • allowBlank: Allows blank values

Validator methods

  • isValid()
  • isFieldValid(fieldName)
  • getErrorMessages()
  • getErrorMessagesForField(fieldName)

Package Sidebar

Install

npm i validator-lib

Weekly Downloads

7

Version

0.0.8

License

MIT

Last publish

Collaborators

  • altovista