list_of

Describes validation rules for a list. The rules are applied to every element.

Error codes: a list with the error of every element (null for valid elements), or FORMAT_ERROR if the value is not a list.

Live example · edit rules or inputOpen in playground

rules

{
    product_ids: { list_of: 'positive_integer' }
}

{ product_ids: { list_of: 'positive_integer' } }

input

{
    product_ids: [3455, 'abc', 0, 3456]
}

{ product_ids: [3455, 'abc', 0, 3456] }

Invaliderrors

{
  "product_ids": [
    null,
    "NOT_POSITIVE_INTEGER",
    "NOT_POSITIVE_INTEGER",
    null
  ]
}

The rules were wrapped in an extra list before v0.4. Both syntaxes are supported:

// new syntax (introduced in v0.4)
{ product_ids: { list_of: 'positive_integer' } }
{ product_ids: { list_of: ['required', 'positive_integer'] } }

// old syntax
{ product_ids: { list_of: [['positive_integer']] } }
{ product_ids: { list_of: [['required', 'positive_integer']] } }