- notEqual:$1
- not-equal-email-domain:$1

$1 is the prohibited domains separated by comma (',')
examples
- not-equal-to-field:$1

Use object notation for defining this rule
examples

- requiredIf::
`js
var input = {message: 'hi!'};
// subject is required if message equals hi!
satpam.validate({subject: 'requiredIf:message:hi!'});
`

For more complex example please see
- requiredIf examples
- noes examples
- requiredIfNot::
`js
var input = {message: 'hi!'};
// subject is required if message does not equal hi!
satpam.validate({subject: 'requiredIfNot:message:hi!'});
`

For more complex example please see
- requiredIfNot examples
- noes examples
- minimumAge::
- taxId:$1 Currently only support indonesian tax id e.g. taxId:id

Use object notation for defining this rule
examples
- beginWith:$1

Use object notation for defining this rule
examples
- pattern:$1:$2

$1 is the pattern, $2 is the regex flags
examples
- uuid:$1

$1 is the version, available options v1, v3, v4, v5, all
examples
- indonesiaIdCardNumberBirthDate:$1:$2

$1 is the Birth Date's key, $2 is the date format used
examples
- indonesiaIdCardNumberGender:$1:$2:$3

$1 is the Gender's key, $2 is the value for male, $3 is the value for female
examples
- indonesiaIdCardNumberProvince:$1

$1 is the Province's Key
examples
- indonesiaIdCardNumberValidProvince

examples
- indonesianName

examples

Complete Examples


`js
const satpam = require('satpam');

// oldValidator will not have must-be-ironman rule, because it's created
// before we add the custom validation.
const oldValidator = satpam.create();

// The global satpam validator will has updated validation rules.
// After this statement, we can do satpam.validate({name: ['must-be-ironman']}, ...);
satpam.addCustomValidation('must-be-ironman', val => val === 'ironman');
satpam.setValidationMessage('must-be-ironman', 'Not ironman D:');

// With parameters
satpam.addCustomValidation('range:$1:$2', (val, ruleObj) => {
return val >= ruleObj.params[0] && val <= ruleObj.params[1];
});

// If validation fails it will set message to:
// "PropertyName must between 0 and 30"
satpam.setValidationMessage('range:$1:$2', '<%= propertyName %> must between <%= ruleParams[0] %> and <%= ruleParams[1] %>');

// newValidator will have must-be-ironman rule because it's created
// after we add the custom validation.
const newValidator = satpam.create();
`

Optional Validation

`js
const rules = {
// It will pass if document is passed and either a pdf or an image
document: ['required', ['fileType:pdf', 'image']]
};
`

Running Validation Based On Some Conditions

`js
const shouldValidateZipCode = (ruleObj, inputObj) => {
return inputObj.livesInJakarta;
};

const rules = {
// Only require zip code if livesInJakarta is truthy
zipCode: [
{name: 'required', shouldValidate: shouldValidateZipCode}
]
};

satpam.validate(rules, {}); // {success: true}
satpam.validate(rules, {
livesInJakarta: true
}); // Will fail
`

Custom Validation Messages

`js
satpam.setValidationMessage(
'minLength:$1',
'<%= propertyName %> must have length more than <%= ruleParams[0] %>'
);
`

You can also pass a Function instead of a String

`js
/**
* @example
* const satpam = require('satpam');
*
* const rules = {name: ['minLength:10']};
* const input = {name: 'wubwub'};
* satpam.validate(rules, input);
*
* expect(ruleObj.name).to.equal('minLength');
* expect(ruleObj.fullName).to.equal('minLength:$1');
* expect(ruleObj.params).to.deep.equal([10]);
* expect(propertyName).to.equal('name');
* expect(value).to.equal('wubwub');
*
* @param {Object} ruleObj
* @param {String} ruleObj.name - The validation rule name
* e.g. minLength:10 will have name minLength
* @param {String} ruleObj.fullName - Validation rule fullname
* e.g. minLength:10 will have fullName minLength:$1
* @param {Array} ruleObj.params - The rule parameters
* e.g. minlength:10 will have params [10]
* @param {String} propertyName
@param {} value
*/
const message = (ruleObj, propertyName, value) => {
...
};
satpam.setValidationMessage('minLength:$1', message);
``

License

!Hi-Five