View Source Kungfuig.Backend behaviour (Kungfuig v1.0.0)

The scaffold for the backend watching the external config source.

Summary

get(list)

The implementation of the call to remote that retrieves the data

key()

The key this particular config would be stored under, defaults to module name

report(any)

The implementation of error reporting

transform(any)

The transformer that converts the retrieved data to internal representation

@callback get([Kungfuig.option()]) :: {:ok, any()} | {:error, any()}

The implementation of the call to remote that retrieves the data

@callback key() :: atom()

The key this particular config would be stored under, defaults to module name

@callback report(any()) :: :ok

The implementation of error reporting

@callback transform(any()) :: {:ok, any()} | {:error, any()}

The transformer that converts the retrieved data to internal representation