CompaniesHouse.Config (CompaniesHouse v0.2.0)

Methods to parse and modify configurations.

Summary

t()

api_key()

Gets the API key from configuration. Raises ConfigError if API key is not configured.

Gets the environment from configuration. Default is :sandbox if not explicitly configured. Raises ConfigError if environment is invalid.

Gets the key value from the environment config.

Puts a new key value to the configuration.

Raise a ConfigError exception.

@type t() :: Keyword.t()

@spec api_key() :: String.t()

Gets the API key from configuration. Raises ConfigError if API key is not configured.

@spec environment() :: :sandbox | :live

Gets the environment from configuration. Default is :sandbox if not explicitly configured. Raises ConfigError if environment is invalid.

@spec get(atom(), any()) :: any()

Gets the key value from the environment config.

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

Puts a new key value to the configuration.

@spec raise_error(binary()) :: no_return()

Raise a ConfigError exception.