Apruve

v0.1.0

Apruve v0.1.0 Apruve.ClientConfig View Source

Module for handling a client configuration which consists mainly of:

Which adapter to use. Which hostname etc. to use. Which Apruve API key key to use.

:options is for adapter specific options

Link to this section Summary

Types

adapter()
api_key()
hostname()
options()
scheme()
t()

Functions

build_config(api_key, hostname, scheme, adapter, options \\ %{})

Build a ClientConfig struct

Link to this section Types

Link to this type adapter() View Source 
adapter() :: atom()
Link to this type hostname() View Source 
hostname() :: String.t()
Link to this type options() View Source 
options() :: map()
Link to this type t() View Source 
t() :: %Apruve.ClientConfig{
  adapter: term(),
  api_key: term(),
  hostname: term(),
  options: term(),
  scheme: term()
}

Link to this section Functions

Link to this function build_config(api_key, hostname, scheme, adapter, options \\ %{}) View Source 
build_config(api_key(), hostname(), scheme(), adapter(), options()) ::
  {:ok, Apruve.ClientConfig.t()}

Build a ClientConfig struct.