is v1.0.0 Is.Validator View Source

Helpers to retrieve or validate validator.

Link to this section Summary

Functions

Returns validator corresponding to given id

Check if given validator is valid or not

Convert list of validators into map with their atom underscore name as key, and module name as value

Link to this section Functions

Link to this function get(validators_map, id) View Source
get(%{required(atom()) => atom()}, atom()) :: {:ok, atom()} | {:error, any()}

Returns validator corresponding to given id.

Examples

iex> get(%{binary: Is.Validators.Binary}, :binary)
{:ok, Is.Validators.Binary}

iex> get(%{binary: Is.Validators.Binary}, :unknown)
{:error, "Validator :unknown does not exist"}
Link to this function is_valid?(validator) View Source
is_valid?(atom()) :: boolean()

Check if given validator is valid or not.

Examples

iex> is_valid?(Is.Validators.Binary)
true

iex> is_valid?(nil)
false

iex> is_valid?(Enum)
false

iex> is_valid?(:binary)
false
Link to this function to_map(validators) View Source
to_map([atom()]) :: %{required(atom()) => atom()}

Convert list of validators into map with their atom underscore name as key, and module name as value.

Examples

iex> to_map([])
%{}

iex> to_map([Is.Validators.Binary, Is.Validators.Boolean, Is.Validators.Map])
%{
  binary: Is.Validators.Binary,
  boolean: Is.Validators.Boolean,
  map: Is.Validators.Map,
}

iex> to_map([Is.Validators.Unknown])
%{}