0.0.1 • Published 2 years ago
js-validation-helper v0.0.1
JavaScript Validator
a validation helper to easily validate your data
Installation
with npm
npm install @baabouj/validator
with yarn
yarn add @baabouj/validator
with pnpm
pnpm install @baabouj/validator
Usage
first let’s import the validator from the package :
using ES modules
import validator from "@baabouj/validator";
using CommonJs
const validator = require("@baabouj/validator");
Now that you imported it, the validator provides you with 2 function :
validate
used to validate fields within an object
const validated = validator.validate(
{
name: "John Doe",
age: 20,
email: "john.doe@gmail.com",
password: "secret",
},
{
name: "required", // with single rule
age: "required|number|gt:18", // with multiple rules
email: ["required", "email"], // with an array of rules
password: [
["required", "Password is required"],
["min:6", "Password must be at least 6 characters long"],
], // with custom error messages
}
);
on case of validation didn’t succussed, the validate function returns an object containing each unvalidated field as a key and an array of error messages for that field as a value.
on validation succussed, the validate function returns null.
check
used to validate a single field
const checked = validator.check(23, "number|gte:18");
// or
const checked = validator.check(23, ["number", "gte:18"]);
// or provide your custom error message
const checked = validator.check(23, [
"number",
["gte:18", "You must be at least 18 years old"],
]);
on case of validation didn’t succussed, the check function returns an array of error messages.
on success, the check function returns null.
Rules
required
checks if the field is not emptyempty
checks if the field is emptyemail
checks if the field is a valid email addressphone
checks if the field is a valid phone numberurl
checks if the field is a valid urllength:{length}
checks if the field’s length is equal to the given lengthmin:{length}
checks if the field’s length is greater than the given lengthmax:{length}
checks if the field’s length is less than the given lengthnumber
checks if the field is a numberboolean
checks if the field is a booleanstring
checks if the field is a stringarray
checks if the field is an arrayobject
checks if the field is an objectfunction
checks if the field is a functionnull
checks if the field is nullundefined
checks if the field is undefinedin:{item},{item} (...)
checks if the field is in the given listnin:{item},{item} (...)
checks if the field is not in the given listeq:{value}
checks if the field is equal to the given valueneq:{value}
checks if the field is not equal to the given valuegt:{value}
checks if the field is greater than the given valuegte:{value}
checks if the field is greater than or equal to the given valuelt:{value}
checks if the field is less than the given valuelte:{value}
checks if the field is less than or equal to the given valuebetween:{min},{max}
checks if the field is between the given valuescontains:{value}
checks if the field contains the given valuesw:{value}
checks if the field starts with the given valueew:{value}
checks if the field ends with the given valueregex:{regex}
checks if the field matches the given regex patternnot:{rule}
checks if the field does not match the given rule
0.0.1
2 years ago