ex_gram v0.8.0 ExGram.Config View Source

This module handles fetching values from the config with some additional niceties

Link to this section Summary

Functions

Fetches a value from the config, or from the environment if {:system, "VAR"} is provided.

Same as get/3, but returns the result as an integer. If the value cannot be converted to an integer, the default is returned instead.

Link to this section Functions

Link to this function

get(app, key, default \\ nil)

View Source
get(atom(), atom(), term() | nil) :: term()

Fetches a value from the config, or from the environment if {:system, "VAR"} is provided.

An optional default value can be provided if desired.

Example

iex> {test_var, expected_value} = System.get_env |> Enum.take(1) |> List.first
...> Application.put_env(:myapp, :test_var, {:system, test_var})
...> ^expected_value = Elixir.ExGram.Config.get(:myapp, :test_var)
...> :ok
:ok

iex> Application.put_env(:myapp, :test_var2, 1)
...> 1 = Elixir.ExGram.Config.get(:myapp, :test_var2)
1

iex> :default = Elixir.ExGram.Config.get(:myapp, :missing_var, :default)
:default
Link to this function

get_integer(app, key, default \\ nil)

View Source
get_integer(atom(), atom(), integer() | nil) :: integer()

Same as get/3, but returns the result as an integer. If the value cannot be converted to an integer, the default is returned instead.