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
})
Show:
buildOptions
(
  • options
  • defaultOptions
  • globalOptions
)
Object

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

Parameters:

Returns:

createErrorMessage
(
  • type
  • value
  • options
)
String

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:

  • type String

    The type of message template to use

  • value Mixed

    Current value being evaluated

  • options Object

    Validator built and processed options (used as the message string context)

Returns:

String:

The generated message

getValue () Mixed private

Wrapper method to value that passes the necessary parameters

Returns:

Mixed:

value

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:

  • value Mixed

    The current value of the attribute

  • options Object

    The built and processed options

  • model Object

    The current model being evaluated

  • attribute String

    The current attribute being evaluated

Returns:

One of the following types:

  • Boolean: true if the current value passed the validation
  • String: The error message
  • Promise: A promise that will either resolve or reject, and will finally return either true or the final error message string.
value
(
  • model
  • attribute
)

Used to retrieve the value to validate. This method gets called right before validate and the returned value gets passed into the validate method.

Parameters:

Returns:

The current value of model[attribute]

_type

String private

Validator type

attribute

String

Attributed name of the model this validator is attached to

defaultOptions

Object

Default validation options for this specific attribute

errorMessages

Object

Error message object. Populated by validators/messages

globalOptions

Object

Global validation options for this model

isWarning

Boolean

model

Model

Model instance

options

Object

Options passed in to the validator when defined in the model