# `NeoFaker.Boolean`
[🔗](https://github.com/muzhawir/neo_faker/blob/main/lib/neo_faker/boolean.ex#L1)

Functions for generating random boolean values.

Provides utilities to generate `true` or `false` with a configurable probability,
with an option to return integer equivalents instead.

# `boolean`
*since 0.5.0* 

```elixir
@spec boolean(0..100, Keyword.t()) :: boolean() | non_neg_integer()
```

Generates a random boolean value with a configurable probability of returning `true`.

The `true_ratio` parameter sets the percentage chance (0–100) of returning `true`.
Pass `integer: true` to receive `1` or `0` instead of `true` or `false`.

## Parameters

- `true_ratio` - Percentage probability of returning `true` (0–100). Defaults to `50`.
- `opts` - Keyword list of options:
  - `:integer` - When `true`, returns `1` or `0`. Defaults to `false`.

## Examples

    iex> NeoFaker.Boolean.boolean()
    false

    iex> NeoFaker.Boolean.boolean(75)
    true

    iex> NeoFaker.Boolean.boolean(75, integer: true)
    1

    iex> NeoFaker.Boolean.boolean(0)
    false

    iex> NeoFaker.Boolean.boolean(100)
    true

---

*Consult [api-reference.md](api-reference.md) for complete listing*