litmus v0.5.0 Litmus.Type.Any View Source

This type provides validation for any type of value.

Options

  • :required - Setting :required to true will cause a validation error when a field is not present or the value is nil. Allowed values for required are true and false. The default is false.

Examples

iex> schema = %{"id" => %Litmus.Type.Any{required: true}}
iex> Litmus.validate(%{"id" => 1}, schema)
{:ok, %{"id" => 1}}

iex> schema = %{"id" => %Litmus.Type.Any{required: true}}
iex> Litmus.validate(%{}, schema)
{:error, "id is required"}

iex> schema = %{"id" => %Litmus.Type.Any{required: true}}
iex> Litmus.validate(%{"id" => nil}, schema)
{:error, "id is required"}

Link to this section Summary

Link to this section Types

Link to this type t() View Source
t() :: %Litmus.Type.Any{required: boolean()}

Link to this section Functions

Link to this function validate_field(type, field, data) View Source
validate_field(t(), String.t(), map()) ::
  {:ok, map()} | {:error, String.t()}