Specs

app_name() :: nil | atom()

Application name.

Specs

binding() :: :config | :system | module()

Variable binding.

Specs

bindings() :: [binding()]

Variable binding list.

Specs

key() :: atom()

Key.

Specs

keys() :: [key()]

List of keys that lead to the value of the variable.

Specs

namespace() :: nil | atom()

Variable namespace.

Specs

option() ::
  {:binding_order, bindings()}
  | {:binding_skip, bindings()}
  | {:os_env, binary()}
  | {:type, type()}
  | {:namespace, namespace()}
  | {:default, term()}
  | {:required, boolean()}
  | {:cached, boolean()}
  | {atom(), term()}

Environment variable options.

• binding_order - Variable binding load order.
• binding_skip - Skips loading a variable from the list of bindings.
• os_env - The name of the OS environment variable.
• type - Type to cast the OS environment variable value.
• namespace - Default namespace for the variable.
• default - Default value.
• required - Whether the variable is required or not.
• cached - Whether the variable is cached or not.

Specs

options() :: [option()]

Environment variable options:

Specs

t() :: %Skogsra.Env{
  app_name: app_name :: app_name(),
  keys: keys :: keys(),
  namespace: namespace :: namespace(),
  options: options :: options()
}

Skogsra environment variable.

Specs

type() ::
  :binary
  | :integer
  | :neg_integer
  | :non_neg_integer
  | :pos_integer
  | :float
  | :boolean
  | :atom
  | :module
  | :unsafe_module
  | :any
  | module()

Types.