PowAssent.Config (PowAssent v0.4.10) 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.

get_provider_config(config, provider)

Gets the provider configuration from the provided configuration.

get_providers(config)

Gets the providers for the configuration.

merge_provider_config(config, provider, new_provider_config)

Merge new config for provider.

put(config, key, value)

Puts a new key value to the configuration.

raise_error(message)

Raise a ConfigError exception.

Link to this section Types

t()

Specs

t() :: Keyword.t()

Link to this section Functions

get(config, key, default \\ nil)

Specs

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.

get_provider_config(config, provider)

Specs

get_provider_config(t(), atom()) :: t() | no_return()

Gets the provider configuration from the provided configuration.

get_providers(config)

Specs

get_providers(t()) :: t()

Gets the providers for the configuration.

merge_provider_config(config, provider, new_provider_config)

Specs

merge_provider_config(t(), atom(), t()) :: t()

Merge new config for provider.

The new config values are deep merged with the existing provider config. Any conflicting keys from the default config for the strategy will be fetched and the provider config deep merged unto it.

put(config, key, value)

Specs

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

Puts a new key value to the configuration.

raise_error(message)

Specs

raise_error(binary()) :: no_return()

Raise a ConfigError exception.