Pow v1.0.16 Pow.Config View Source

Methods to parse and modify configurations.

Link to this section Summary

Types

t()

Functions

get(config, key, default \\ nil)

Gets the key value from the configuration.

merge(l_config, r_config)

Merges two configurations.

put(config, key, value)

Puts a new key value to the configuration.

raise_error(message)

Raise a ConfigError exception.

Retrieves the repo module from the config, or raises an exception.

Retrieves the user schema module from the config, or raises an exception.

Link to this section Types

t()

t() :: Keyword.t()

Link to this section Functions

get(config, key, default \\ nil)

get(t(), atom(), any()) :: any()

Gets the key value from the configuration.

If not found, it'll fall back to environment config, and lastly to the default value which is nil if not specified.

merge(l_config, r_config)

merge(t(), t()) :: t()

Merges two configurations.

put(config, key, value)

put(t(), atom(), any()) :: t()

Puts a new key value to the configuration.

raise_error(message)

raise_error(binary()) :: no_return()

Raise a ConfigError exception.

repo!(config)

repo!(t()) :: atom() | no_return()

Retrieves the repo module from the config, or raises an exception.

user!(config)

user!(t()) :: atom() | no_return()

Retrieves the user schema module from the config, or raises an exception.