Talos v0.3.2 Talos.Types.ArrayType View Source
ArrayType is used to check passed value is a list
iex> alias Talos.Types.ArrayType
iex> alias Talos.Types.IntegerType
iex> Talos.valid?(%ArrayType{allow_blank: true}, [])
true
iex> Talos.valid?(%ArrayType{allow_nil: true}, nil)
true
iex> Talos.valid?(%ArrayType{}, nil)
false
iex> Talos.valid?(%ArrayType{}, ["one", two, 3, %{}])
true
iex> Talos.valid?(%ArrayType{type: %IntegerType{}}, ["one", two, 3, %{}])
false
iex> Talos.valid?(%ArrayType{type: %IntegerType{}}, [1,2,3])
true
iex> Talos.valid?(%ArrayType{type: %IntegerType{allow_nil: true}}, [nil,2,3])
true
Additional parameters:
allow_blank
- allows array to be empty
allow_nil
- allows value to be nil
type
- defines type of array elements
Link to this section Summary
Functions
Callback implementation for Talos.Types.errors/2
.
Callback implementation for Talos.Types.valid?/2
.
Link to this section Types
Link to this section Functions
Link to this function
errors(array_type, values)
View Sourceerrors(Talos.Types.ArrayType.t(), any()) :: [String.t()]
Callback implementation for Talos.Types.errors/2
.
Link to this function
valid?(array_type, values)
View Sourcevalid?(Talos.Types.ArrayType.t(), any()) :: boolean()
Callback implementation for Talos.Types.valid?/2
.