Packages

funx

0.8.8
0.8.8 0.8.7 0.8.6 0.8.5 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.1 0.6.0 0.5.0 0.4.2 0.4.0 0.3.0 0.2.3 0.2.2 0.2.1 0.2.0 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3

Functional programming abstractions for Elixir (Beta release: APIs may change before 1.0)

HexDocs

Current section

Files

Jump to
Readme
26 Versions
1 Dependency
Dependants
Files
Activity
funx lib validator boolean.ex
Raw

lib/validator/boolean.ex 

defmodule Funx.Validator.Boolean do

  @moduledoc """

  Validates that a value is a boolean (true or false).



  ## Optional Options



  - `:message` - Custom error message callback `(value -> String.t())`



  ## Examples



      iex> Funx.Validator.Boolean.validate(true)

      %Funx.Monad.Either.Right{right: true}



      iex> Funx.Validator.Boolean.validate(false)

      %Funx.Monad.Either.Right{right: false}



      iex> Funx.Validator.Boolean.validate("true")

      %Funx.Monad.Either.Left{left: %Funx.Errors.ValidationError{errors: ["must be a boolean"]}}

  """



  use Funx.Validator



  alias Funx.Predicate



  @impl Funx.Validator

  def valid?(value, opts, _env) do

    predicate = Predicate.Boolean.pred(opts)

    predicate.(value)

  end



  @impl Funx.Validator

  def default_message(_value, _opts) do

    "must be a boolean"

  end

end