This library contains list of classes that allows developers to create custom validation flows.
The main idea to have configured form with rules for each field. Each field can be validated by specific constraint.
Validation constraints inspired by Symfony Constraints.
npm i constraint-validator --savevar validator = require("constraint-validator");
var form = new validator.Form();
form
.add('email', [
new validator.NotBlank(),
new validator.Email(),
])
.add('password', [
new validator.NotBlank(),
new validator.Length({min: 6}),
]);
var errors = form.validate({
email: '[email protected]',
password: '123456',
});import { Form, NotBlank, Email, Length } from 'constraint-validator';
const form = new Form();
form
.add('email', [
new NotBlank(),
new Email(),
])
.add('password', [
new NotBlank(),
new Length({min: 6}),
]);
const errors = form.validate({
email: '[email protected]',
password: '1234567',
});In case of form data is not valid the errors object contains properties (related to from filed names) and array of Error objects.
{
'email': [
Error,
Error,
],
'password': [
Error,
]
}Otherwise error variable will be empty object {}
Data transformers are used to translate the data for a field into a other format and back. The data transformers act as middleware and will be executed in the same order as they were applied.
There are 2 types of data transformers:
- transformer - executes before validation process
- reverseTransformers - executes after validation process
import { Form, NotBlank, Email } from 'constraint-validator';
const form = new Form();
form
.add('email', [
new NotBlank(),
new Email(),
])
// next transformers will be applied to the form data
.addTransformer(data => {
data.email += '@example.com'
return data;
})
.addReverseTransformer(data => {
data.email = data.email.replace(/@example.com/, '@example.me');
return data;
});
form.validate({email: 'email'});
console.log(form.getData());
// Output:
// {"email": "[email protected]"}import { Form, NotBlank, Email } from 'constraint-validator';
const form = new Form();
form
.add('email', [
new NotBlank(),
new Email(),
])
.get('email')
// next transformers will be applied to the 'email' field only
.addTransformer(value => value + '@example.com')
.addReverseTransformer(value => value.replace(/@example.com/, '@example.me'));
form.validate({email: 'email'});
console.log(form.getData());
// Output:
// {"email": "[email protected]"}-
Form - form configuration
-
Field - form field object
-
Constraints - list of supported constraints Basic constraints:
String constraints:
Comparison constraints:
Number constraints:
Date constraints:
Choice constraints:
Financial and other Number Constraints:
Other constraints:
You can create custom constrains by using deep integration.
- locutus - JavaScript implementation of PHP functions
- Luxon Moment - DateTime manipulation library
- IpAddrJs - IP address manipulation library
Q: Why not exceptions?
A: See try/catch performance test
Q: Is there same logic as symfony has?
A: No, please check documentation for each constraint
- Provide
types.d.tsfor better user experience - CI/CD build flow (drop
distfolder) - Proper package integration (get IDE autocomplete working better)
- Investigate DayJS as replacements: find a way to validate timezones.