Common Options

description

A descriptor for your attribute used in the error message strings. Defaults to This field'. You can overwrite this value in your validators/messages.js file by changing the defaultDescription property.

// Examples
validator('date', {
  description: 'Date of birth'
})
// If validation is run and the attribute is empty, the error returned will be:
// 'Date of birth can't be blank'

dependentKeys

A list of other model specific dependents for you validator.

// Examples
validator('has-friends', {
  dependentKeys: ['friends.[]']
})
validator('has-valid-friends', {
  dependentKeys: ['friends.@each.username']
})
validator('x-validator', {
  dependentKeys: ['username', 'email', 'meta.foo.bar']
})

disabled

If set to true, disables the given validator. This option would usually go hand-in-hand with options as functions and dependentKeys. Defaults to false.

// Examples
validator('presence', {
  presence: true,
  disabled: true
})
validator('presence', {
  presence: true,
  dependentKeys: ['shouldValidate'],
  disabled(model, attribute) {
    return !model.get('shouldValidate');
  }
})

debounce

Debounces the validation with the given time in milliseconds. All debounced validations will be handled asynchronously (wrapped in a promise).

// Examples
validator('length', {
  debounce: 500
})
validator('x-validator', {
  debounce: 250
})

value

Used to retrieve the value to validate. This will overwrite the validator's default value method. By default this returns model[attribute]. If you are dependent on other model attributes, you will need to add them as dependentKeys.

// Examples
validator('date', {
  value(model, attribute) {
    // Format the orignal value before passing it into the validator
    return moment().utc(model.get(attribute)).format('DD/MM/YYY');
  }
})
validator('number', {
     dependentKeys: ['someOtherAttr'],
  value(model, attribute) {
    // Validate a value that is not the current attribute
    return this.get('model').get('someOtherAttr');
  }
})

message

This option can take two forms. It can either be a string or a function. If a string is used, then it will overwrite all error message types for the specified validator.

// Example: String
validator('confirmation', {
  message: 'Email does not match {attribute}. What are you even thinking?!'
})

We can pass a function into our message option for even more customization capabilities.

// Example: Function
validator('date', {
  message: function(type, options, value, context) {
    if (type === 'before') {
      return '{description} should really be before {date}';
    }
    if (type === 'after') {
      return '{description} should really be after {date}';
    }
  }
})

The message function is given the following arguments:

• type (String): The error message type
• options (Object): The validator options that were defined in the model
• value: The current value being evaluated
• context (Object): Context for string replacement

The return value must be a string. If nothing is returned (undefined), defaults to the default error message of the specified type.

Within this function, the context is set to that of the current validator. This gives you access to the model, defaultMessages, options and more.