input-field-validator v3.1.0

Input Field Validator

A Javascript input validation library heavily inspired by Laravel's input validation.

Example

const Validator = require('input-field-validator');

const validation = new Validator(
	req.body,
	{
		first_name: ['required', 'minlength:3'],
		last_name: ['required', 'minlength:3'],
		username: ['required', 'minlength:3', 'lowercase'],
		email: ['required', 'email', 'lowercase'],
		password: ['required', 'minlength:8'],
		password_confirm: ['required', 'same:password'],
		dob: ['required', 'date:before:2010-01-01'],
		gender: ['required', 'in:male,female,unspecified'],
		tags: ['optional', 'array', 'minlength:3', 'maxlength:32'],
		location: {
		    country: ['required', 'minlength:3'],
			city: ['optional', 'minlength:3']
		}
	}
);

if (!validation.validate ())
	throw new Error(validation.errors.join (', '));

Available validators

• array
• required
• optional
• integer
• number
• email
• url
• length (length:3 checks if the input string is exactly 3 characters long)
• maxlength (minlength:3 checks if the input string is at least 3 characters long)
• minlength (maxlength:8 checks if the input string is at most 8 characters long)
• in (in:joske,maria,piet checks if the input string is equal to either joske, maria or piet)
• same (same:password_confirmation checks if the value is equal to the value of the password_confirmation field)
• different (different:old_password checks if the value is different from the value of the old_password field)
• required_with (required_with:old_password makes the field required if the old_password field is present in the input)
• required_without (required_without:email makes the field required if the email field is not present in the input)
• required_if (required_if:gender,unspecified makes the field required if the gender field is is equal to unspecified)
• lowercase (checks if the input string consists entirely of lower case characters)
• uppercase (checks if the input string consists entirely of upper case characters)
• alpha (alphabetic characters)
• alpha_num (alphanumeric characters)
• alpha_dash (alphanumeric characters, dashes and underscores)
• date (checks if the input is a valid date)
• date:before (date:before:now checks if the input date is in the past, date:before:1995-02-03 checks if the input date is before the 3rd of February 1995)
• date:after (date:before:now checks if the input date is in the past, date:after:1995-02-03 checks if the input date is after the 3rd of February 1995)
• date:equal (date:before:now checks if the input date is today's date, date:equal:1995-02-03 checks if the input date is the 3rd of February 1995)
• boolean (checks if the input is a boolean value; accepted values are true, false, 0, 1, "true", "false", "0" and "1")
• object (checks if the input is an object)
• distinct (checks that the field's value is not present anywhere else in the input)
• ip (checks that the field's value is either a valid IPv4 or IPv6 address)
• ipv4 (checks that the field's value is a valid IPv4 address)
• ipv6 (checks that the field's value is a valid IPv6 address)
• json: Checks that the field's value is a valid JSON string
  • Values with leading or trailing whitespace are considered valid (they will be automatically trimmed) Both JSON objects and JSON arrays are considered valid Empty JSON objects ({}) and JSON arrays ([]) are considered valid * While "hello world", 1 and true (string literals, numbers and booleans) are technically valid JSON, this validator is meant to check specifically whether something is a JSON object or a JSON array, and as such for the purpose of this validator they are considered to be invalid.
• regex (tests the input value against the given regular expression) * Example: regex:^[a-z\-]{5,}$
• uuid (checks whether the input value is an RFC 4122 compliant UUID)

Nested validation is also supported by simply providing an object with keys matching the map in the input, and their validation rules. See the location field in the example above.