# `Faker`
[🔗](https://github.com/artkay/fakerer/blob/v1.0.0/lib/faker.ex#L1)

Main module to start application with some helper functions.

# `country`

```elixir
@spec country() :: atom()
```

Returns application country.

# `format`

```elixir
@spec format(String.t()) :: String.t()
```

Internal function to format string.

It replaces `"#"` to random number and `"?"` to random Latin letter.

# `locale`

```elixir
@spec locale() :: atom()
```

Returns application locale.

# `locale`

```elixir
@spec locale(atom()) :: :ok
```

Sets application locale.

# `localize`
*macro* 

# `mlocale`

```elixir
@spec mlocale() :: String.t()
```

Returns application locale ready for module construct.

# `random_between`

```elixir
@spec random_between(integer(), integer()) :: integer()
```

Returns a (pseudo) random number as an integer between the range intervals.

## Examples

    iex> random_between(3, 7) in [3, 4, 5, 6, 7]
    true

# `random_bytes`

```elixir
@spec random_bytes(pos_integer()) :: binary()
```

Returns a random bytes.

# `random_uniform`

```elixir
@spec random_uniform() :: float()
```

Returns a random float in the value range 0.0 =< x < 1.0.

## Examples

    iex> is_float(random_uniform())
    true

# `sampler`
*macro* 

# `samplerp`
*macro* 

# `shuffle`

```elixir
@spec shuffle(Enum.t()) :: list()
```

Returns a shuffled enum.

# `start`

```elixir
@spec start() :: :ok
```

Starts Faker with default locale.

# `start`

```elixir
@spec start(atom()) :: :ok
```

Starts Faker with `lang` locale.

---

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