evalidate-typescript v1.0.0

evalidate

A fast and easy to use Object Schema Validator

Index

• Install
• Usage
• License

Install

npm install --save evalidate

Usage

Importing

// Using require()
const evalidate = require("evalidate");

// Using ES6 import
import evalidate from "evalidate"

Defining a Schema

let schema = new evalidate.schema({
    name: evalidate.string(),
    email: evalidate.string().required().email(),
    age: evalidate.number().min(18).max(150),
    status: evalidate.string().required().in(["Active", "Deacive"]),
    address: evalidate.object({
        city: evalidate.string(),
        country: evalidate.string().required(),
    }),
    birthday: evalidate.date().required().before(new Date())
});

Custom Error Message

let schema = new evalidate.schema({
    email: evalidate.string().required("email is required!").email("Please enter a valid email address!"),
    age: evalidate.number().min(18, "Too young!").max(150, "Too old!"),
});

Validating Data

let result = schema.validate({
    name: "xxxx-xxxx",
    email: "xxxx@gmail.com",
    age: 18,
    status: "Active",
    address: {
        city: "xxxx",
        country: "xxxx"
    },
    birthday: "2019-01-01"
});

if (!result.isValid) {
    console.log(result.errors);
}

Validators

Array: evalidate.array()

• contains(value, message)

  • Check if input array contains a value
  • (Optional) Custom error message

• equals(value, message)

  • Check if input array has the same content as a given array(value)
  • value must be an array
  • (Optional) Custom error message

• required(message)

  • (Optional) Custom error message

• size(value, message)

  • Check the length of the input array
  • (Optional) Custom error message

Boolean: evalidate.boolean()

• equals(value, message)

  • Check if boolean matches value
  • value must be boolean
  • (Optional) Custom error message

• required(message)

  • (Optional) Custom error message

Date: evalidate.date()

• after(value, message)

  • Check if input date is after a given date
  • value cab be a date object, an integer value representing the number of milliseconds since January 1, 1970 or string value representing a date, specified in a format recognized by the Date.parse() method.
  • (Optional) Custom error message

• before(value, message)

  • Check if input date is before a given date
  • value cab be a date object, an integer value representing the number of milliseconds since January 1, 1970 or string value representing a date, specified in a format recognized by the Date.parse() method.
  • (Optional) Custom error message

• equals(value, message)

  • Check if input date is the same as a given date
  • value cab be a date object, an integer value representing the number of milliseconds since January 1, 1970 or string value representing a date, specified in a format recognized by the Date.parse() method.
  • (Optional) Custom error message

• required(message)

  • (Optional) Custom error message

Number: evalidate.number()

• equals(value, message)

  • Check if input equals value
  • value must be a number
  • (Optional) Custom error message

• integer(message)

  • Check if input number is an integer
  • (Optional) Custom error message

• min(value, message)

  • Check if input number is greater than or equal to a given value
  • value must be a number
  • (Optional) Custom error message

• max(value, message)

  • Check if input number is less than or equal to a given value
  • value must be a number
  • (Optional) Custom error message

• required(message)

  • (Optional) Custom error message

String: evalidate.string()

• alphanumeric(message)

  • Check if input contains only alphanumeric characters
  • (Optional) Custom error message

• credit_card(message)

  • Check if input is a valid credit card number
  • (Optional) Custom error message

• email(message)

  • Check if input is a valid email address
  • (Optional) Custom error message

• equals(value, message)

  • Check if input equals value
  • value must be a string
  • (Optional) Custom error message

• fqdn(message)

  • Check if input is a valid fully qualified domain name
  • (Optional) Custom error message

• in(value, message)

  • Check if input string is in a given array
  • value must be an array
  • (Optional) Custom error message

• isbn(message)

  • Check if input is a valid ISBN
  • (Optional) Custom error message

• maxlength(value, message)

  • Check if number of characters in the input string are less than or equal to a given value
  • value must be a number
  • (Optional) Custom error message

• milength(value, message)

  • Check if number of characters in the input string are greater than or equal to a given value
  • value must be a number
  • (Optional) Custom error message

• required(message)

  • (Optional) Custom error message

• url(message)

  • Check if input is a URL
  • (Optional) Custom error message

License

MIT © aderabiruk