Validates that the attributes’ values are included in a given list. All comparisons are done using strict equality so type matters! For range, the value type is checked against both lower and upper bounds for type equality.
Examples
validator('inclusion', {
in: ['User', 'Admin']
})
validator('inclusion', {
range: [0, 5] // Must be between 0 (inclusive) to 5 (inclusive)
})
Because of the strict equality comparisons, you can use this validator in many different ways.
validator('inclusion', {
in: ['Admin'] // Input must be equal to 'Admin'
})
validator('inclusion', {
range: [0, Infinity] // Input must be positive number
})
validator('inclusion', {
range: [-Infinity, Infinity] // Input must be a number
})
-
options -
defaultOptions -
globalOptions
Build options hook. Merges default options into options object. This method gets called on init and is the ideal place to normalize your options. The presence validator is a good example to checkout
Returns:
-
type -
value -
options
Used by all pre-defined validators to build an error message that is present
in validators/message or declared in your i18n solution.
If we extended our default messages to include uniqueUsername: '{username} already exists',
we can use this method to generate our error message.
validate(value, options) {
const exists = false;
// check with server if username exists...
if(exists) {
// The username key on the options object will be used to create the error message
options.username = value;
return this.createErrorMessage('uniqueUsername', value, options);
}
return true;
}
If we input johndoe and that username already exists, the returned message would be 'johndoe already exists'.
Parameters:
Returns:
The generated message
Wrapper method to value that passes the necessary parameters
Returns:
value
-
type -
args
Easily compose complicated validations by using this method to validate against other validators.
validate(value, options, ...args) {
let result = this.test('presence', value, { presence: true }, ...args);
if (!result.isValid) {
return result.message;
}
// You can even test against your own custom validators
result = this.test('my-validator', value, { foo: 'bar' }, ...args);
if (!result.isValid) {
return result.message;
}
result = this.test('number', value, { integer: true }, ...args);
// You can easily override the error message by returning your own.
if (!result.isValid) {
return 'This value must be an integer!';
}
// Add custom logic...
return true;
}
Parameters:
-
typeStringThe validator type (e.x. 'presence', 'length', etc.) The following types are unsupported: 'alias', 'belongs-to', 'dependent', 'has-many'
-
args...argsThe arguments to pass through to the validator
Returns:
The test result object which will contain isValid
and message. If the validator is async, then the
return value will be a promise.