A validator can also be declared with an inline function. The function will be then wrapped in the Base Validator class and used just like any other pre-defined validator.
// Example
validator(function(value, options, model, attribute) {
return value === get(options, 'username') ? true : must be ${get(options, 'username')};
} , {
username: 'John' // Any options can be passed here
})
-
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) {
var exists = false;
get(options, 'description') = 'Username';
get(options, 'username') = value;
// check with server if username exists...
if(exists) {
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
-
value -
options -
model -
attribute
The validate method is where all of your logic should go. It will get passed in the current value of the attribute this validator is attached to. Within the validator object, you will have access to the following properties:
Parameters:
Returns:
One of the following types:
Boolean:trueif the current value passed the validationString: The error messagePromise: A promise that will either resolve or reject, and will finally return eithertrueor the final error message string.