Format
Validate over a predefined or custom regular expression.
Options
allowBlank(Boolean): If true, skips validation if the value is emptytype(String): Can be the one of the following options [email,phone,url]regex(RegExp): The regular expression to test against
// Examples
validator('format', {
type: 'email'
})
validator('format', {
allowBlank: true,
type: 'phone'
})
validator('format', {
type: 'url'
})
validator('format', {
regex: /^(?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{4,8}$/,
message: 'Password must include at least one upper case letter, one lower case letter, and a number'
})
If you do not want to use the predefined regex for a specific type, you can do something like this
// Example
validator('format', {
type: 'email',
regex: /My Better Email Regexp/
})
This allows you to still keep the email error message but with your own custom regex.
Properties
Methods
buildOptions
-
options -
defaultOptions -
globalOptions
Normalized options passed in by applying the desired regex or using the one declared
Returns:
createErrorMessage
-
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;
options.description = 'Username';
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
getValue
()
Unknown
private
Wrapper method to value that passes the necessary parameters
Returns:
value
processOptions
()
Object
Creates a new object and calls any option property that is a function with the validator context.
This method is called right before validate and the returned object gets passed into the validate method as its options
Returns:
validate
-
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.
Properties
model
Model
Model instance