Packages

neo_faker

0.4.3
0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.1 0.6.0 retired 0.5.0 retired 0.4.4 retired 0.4.3 retired 0.4.2 retired 0.3.1 retired

Fake data generator for Elixir tests and development environments.

Retired package: Deprecated - Please use a newer version
HexDocs

Current section

Files

Jump to
Readme
15 Versions
0 Dependencies
Dependants
Files
Activity
neo_faker lib nf boolean.ex
Raw

lib/nf/boolean.ex 

defmodule Nf.Boolean do

  @moduledoc """

  Functions for generating boolean values.

  """

  @moduledoc since: "0.5.0"



  @doc """

  Generate a boolean value.



  Returns a boolean value, default true ratio is 50% if no argument is provided.



  ## Examples



      iex> Nf.Boolean.boolean()

      true



      iex> Nf.Boolean.boolean(50)

      false



  """

  @spec boolean(pos_integer()) :: boolean()

  def boolean(true_ratio \\ 50) when true_ratio in 0..100 do

    :rand.uniform() <= true_ratio / 100

  end

end