hush v0.4.0 Hush.Provider behaviour View Source

Hush relies on providers to resolve values that the consumer requests.

You can read here on how to write your own provider.

Link to this section Summary

Fetch a value from a provider

Is the provider a valid one?

fetch(module(), String.t(), Keyword.t()) ::
  {:ok, String.t() | nil} | {:error, :required} | {:error, any()}

Fetch a value from a provider

valid?(module()) :: :ok | {:error, String.t()}

Is the provider a valid one?

fetch(key :: String.t()) ::
  {:ok, String.t()} | {:error, :not_found} | {:error, any()}

load(config :: Keyword.t()) :: :ok | {:error, any()}