Talos.Types.ListType (Talos v1.12.3) View Source

ListType is used to check passed value is a list

  iex> import Talos
  iex> Talos.valid?(list(allow_blank: true), [])
  true
  iex> Talos.valid?(list(allow_nil: true), nil)
  true
  iex> Talos.valid?(list(), nil)
  false
  iex> Talos.valid?(list(), ["one", two, 3, %{}])
  true
  iex> Talos.valid?(list(type: integer()), ["one", two, 3, %{}])
  false
  iex> Talos.valid?(list(type: integer()), [1,2,3])
  true
  iex> Talos.valid?(list(type: integer(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

Types

t()

Functions

errors(array_type, values)

Callback implementation for Talos.Types.errors/2.

permit(list_type, list)

valid?(module, value)

Callback implementation for Talos.Types.valid?/2.

Link to this section Types

t()

Specs

t() :: %{
  __struct__: atom(),
  type: struct() | module() | nil,
  allow_blank: boolean(),
  allow_nil: boolean(),
  example_value: any()
}

Link to this section Functions

errors(array_type, values)

Specs

errors(t(), any()) :: [String.t()]

Callback implementation for Talos.Types.errors/2.

permit(list_type, list)

Specs

permit(t(), any()) :: any()

valid?(module, value)

Specs

valid?(t(), any()) :: boolean()

Callback implementation for Talos.Types.valid?/2.