+
+ +

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.

+

Options

+
    +
  • 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
    • +
+
// 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.

+
// Examples
+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
+})
+
+ +
+