# `Forex.Fetcher.Supervisor`
[🔗](https://github.com/greven/forex/blob/1.1.2/lib/forex/fetcher/fetcher_supervisor.ex#L1)

Supervisor for the Forex.Fetcher module that fetches exchange rates.

The Supervisor provides functionality to start, stop and restarting the `Forex.Fetcher`.

The `Forex.Fetcher.Supervisor` accepts the following options:

* `auto_start` - A boolean value that determines if the fetcher process should be started
  automatically when the supervisor is started. The default value is `true`.

* `use_cache` - A boolean value that determines if the cache should be used.
  The default value is `true`.

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

# `delete_fetcher`

Delete the Forex exchange rate fetcher process from the supervisor.

# `fetcher_initiated?`

Check if the Forex exchange rate fetcher process has been initiated.

# `fetcher_running?`

Check if the Forex exchange rate fetcher process is running.

# `fetcher_status`

Get the status of the Forex exchange rate fetcher process.
If the process is running, it returns `:running`,
if it has been initiated but not running, it returns `:stopped`,
otherwise, it returns `:not_started`.

# `restart_fetcher`

Restart the stoped Forex exchange rate fetcher process.

# `start_fetcher`

Start the Forex exchange rate fetcher process.

# `start_fetcher`

# `start_link`

Starts the `Forex.Fetcher.Supervisor` process.

This function should be called in your application supervision tree to start
the Forex exchange rate fetcher.

## Options

* `auto_start` - A boolean value that determines if the fetcher process should be started
  automatically when the supervisor is started. The default value is `true`.

* `use_cache` - A boolean value that determines if the cache should be used.
  The default value is `true`.

* `name` - The name to register the supervisor process under. Defaults to
  `Forex.Fetcher.Supervisor`.

# `stop_fetcher`

Stop the Forex exchange rate fetcher process.

---

*Consult [api-reference.md](api-reference.md) for complete listing*