Specs

all_required_touched?(group_name :: atom(), GenServer.server()) :: boolean()

Returns true if all required variables in specified group are present in store.

Specs

any_required_touched?(group_name :: atom(), GenServer.server()) :: boolean()

Returns true if any required variable in specified group is present in store.

If variable is present, then it means you was trying to configure the group. This is needed for conditional configuration of applications that may shutdown the system if you try to configure the application with invalid params.

Example

if Confispex.any_required_touched?(:apns) do
  config :pigeon, :apns,
    sandbox: %{
      cert: Confispex.get("APNS_CERT"),
      key: Confispex.get("APNS_KEY"),
      mode: :dev
    }
end

Specs

get(Confispex.Schema.variable_name(), GenServer.server()) :: any()

Get a value from store by specified variable name (key) and cast it according to schema.

Example

config :my_app, MyApp.Repo, url: Confispex.get("DATABASE_URL")

In case of any error during casting nil is returned, errors are saved and can be retrieved later using report/1 function.

Specs

init(
  %{
    :schema => module(),
    :context => context(),
    optional(:store) => store() | (() -> store())
  },
  GenServer.server()
) :: :ok

Initialize or reinitialize a state in server

Example

Confispex.init(%{
  schema: MyApp.RuntimeConfigSchema,
  context: %{env: config_env(), target: config_target()}
})

By default, Confispex uses System.get_env/0 to setup the store.

Specs

init_once(
  %{
    :schema => module(),
    :context => context(),
    optional(:store) => store() | (() -> store())
  },
  GenServer.server()
) :: :ok

Initialize a state in server if it hasn't already been initialized

Example

Confispex.init(%{
  schema: MyApp.RuntimeConfigSchema,
  context: %{env: config_env(), target: config_target()}
})

By default, Confispex uses System.get_env/0 to setup the store.

Specs

report(:detailed | :brief, GenServer.server()) :: :ok

Print report with variables usage to STDOUT.

The difference between :detailed and :brief modes is that :brief doesn't print values of the store. Use :brief if you don't want to show sensitive data.

Example

Confispex.report(:detailed)

Specs

update_store((store() -> store()), GenServer.server()) :: :ok

Update a store

Example

new_store = %{...}

Confispex.update_store(&Map.merge(&1, new_store))