Exp-Validtor is a wrapper for validator package to use like a Express middleware. Here is a list of the validators currently available.
- Cover all validator rules.
- Easy to use like a Express middleware.
- Easy to custom rules.
- Easy to custom messages and attributes.
Install package with npm.
npm i @vqq/exp-validatorOr yarn
yarn add @vqq/exp-validatorRequire package to main server.
const expValidator = require('@vqq/exp-validator');Set up locale for validator
expValidator.locale.readMessages();You can set locale code or set path to your language file by json format.
expValidator.locale.setLocale('jp').readMessages();
expValidator.locale.setLocale('jp').setPath('path/:locale/filename.json').readMessages();Set your own custom rules by setCustomRules
expValidator.setCustomRules({
isTest: function(str, param1, param2) { return str === param1 && param2.check === 'check param 2'; }
});Finally, Use your Exp-Validator like a middleware.
const app = express();
app.post('/create', expValidator.validate({
email: [
'nullable',
'isEmail',
{isByteLength: [{min:15, max: 50 }]}
],
test: [
{isTest: ['check param 1', {check: 'check param 2'}]}
]
})
,function (req, res) {
// Your code here
});Change options by passing a object after rules. data option
expValidator.validate({
email: [
'isEmail'
],
}, {data: {
email: '[email protected]'
}});method option (COOKIE, HEADER)
expValidator.validate({
email: [
'isEmail'
],
}, {method: 'COOKIE'});messages and attributes options
expValidator.validate({
email: [
'isEmail'
],
test: [
{isTest: ['check param 1', {check: 'check param 2'}]}
]
}, {
messages: {
'isEmail': 'The :attribute must be a valid email address.',
'test.isTest': 'The :attribute must be equal "%(params[0])s" and param 2 must be equal "%(params[1].check)s".',
},
attributes: {
'email': 'Email',
'test': 'Test Param'
}
});If you want to response all error messages for every rule. you can set checkFirst option to false.
expValidator.validate({
email: [
'nullable',
'isEmail',
{isByteLength: [{min:15, max: 50 }]}
]
}, {checkFirst: false})nullable rule is special rule. It won't check other rules if your field is empty.
You can use validator by your own way. Like this:
const express = require('express');
const expValidator = require('@vqq/exp-validator');
const app = express();
// expValidator.locale.readMessages();
expValidator.setCustomRules({
isTest: function(str, param1, param2) { return str === param1 && param2.check === 'check param 2'; }
});
expValidator.validator.setMessages({
'isEmail': 'The :attribute must be a valid email address.',
'test.isTest': 'The :attribute must be equal "%(params[0])s" and param 2 must be equal "%(params[1].check)s".',
}).setAttributes({
'email': 'Email',
'test': 'Test Param'
});
app.post('/create', function (req, res) {
const result = expValidator.validator.setData({
email: 'youremail@domain',
test: 'check param 2'
}).setRules({
email: [
'isEmail'
],
test: [
{isTest: ['check param 1', {check: 'check param 2'}]}
]
}).validate();
if (result) {
return res.status(422).send(result);
}
// Your code here
return res.status(200).send('success');
});
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent