Money.ExchangeRates.Callback behaviour (Money v6.1.0)

Copy Markdown View Source

Default exchange rates retrieval callback module.

When exchange rates are successfully retrieved, the function latest_rates_retrieved/2 or historic_rates_retrieved/2 is called to perform any desired serialization or processing.

Summary

Callbacks

Invoked after historic exchange rates for a given date have been successfully retrieved. Use this callback to perform any desired side effects such as persisting rates to a database.

Invoked after the latest exchange rates have been successfully retrieved. Use this callback to perform any desired side effects such as persisting rates to a database.

Functions

Callback function invoked when historic exchange rates are retrieved.

Callback function invoked when the latest exchange rates are retrieved.

Callbacks

historic_rates_retrieved(map, t)

@callback historic_rates_retrieved(%{}, Date.t()) :: :ok

Invoked after historic exchange rates for a given date have been successfully retrieved. Use this callback to perform any desired side effects such as persisting rates to a database.

latest_rates_retrieved(map, t)

@callback latest_rates_retrieved(%{}, DateTime.t()) :: :ok

Invoked after the latest exchange rates have been successfully retrieved. Use this callback to perform any desired side effects such as persisting rates to a database.

Functions

historic_rates_retrieved(rates, date)

@spec historic_rates_retrieved(%{}, Date.t()) :: :ok

Callback function invoked when historic exchange rates are retrieved.

latest_rates_retrieved(rates, retrieved_at)

@spec latest_rates_retrieved(%{}, DateTime.t()) :: :ok

Callback function invoked when the latest exchange rates are retrieved.