Exop v0.4.6 Exop.Validation

Provides high-level functions for a contract validation. The main function is valid?/2 Mostly invokes Exop.ValidationChecks module functions.

Summary

Checks inner item of the contract param (which is a Map itself) with their own checks

Validate received params over a contract

Validate received params over a contract. Accumulate validation results into a list

validation_error :: {:error, {:validation, map}}

check_inner(check_items, item_name, cheks)

check_inner(map | Keyword.t, atom, map | Keyword.t) :: list

Checks inner item of the contract param (which is a Map itself) with their own checks.

iex> Exop.Validation.check_inner(%{param: 1}, :param, [type: :integer, required: true])
true

errors_message(errors)

errors_message(map) :: String.t

valid?(contract, received_params)

valid?([map], Keyword.t | map) ::
  :ok |
  validation_error

Validate received params over a contract.

iex> Exop.Validation.valid?([%{name: :param, opts: [required: true]}], [param: "hello"])
:ok

validate(list, received_params, result)

validate([map], map | Keyword.t, list) :: list

Validate received params over a contract. Accumulate validation results into a list.

iex> Exop.Validation.validate([%{name: :param, opts: [required: true, type: :string]}], [param: "hello"], [])
[true, true]