See All Options

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
})
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
)

Inherited from Base but overwritten in ember-validators/addon/inclusion.js:22

Parameters:

  • value Any
  • options Object
    • allowBlank Boolean

      If true, skips validation if the value is empty

    • in Array

      The list of values this attribute could be

    • range Array

      The range in which the attribute's value should reside in

  • model Object
  • attribute 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