forecastr v0.2.5 Forecastr

Forecastr is an application that queries the Open Weather Map API

The Forecastr user API is exposed in this way:

Query the backend weather API for today's weather

Forecastr.forecast(:today, query, params \ %{}, renderer \ Forecastr.Renderer.ASCII )

Query the backend weather API for the forecast in the next days

Forecastr.forecast(:next_days, query, params \ %{}, renderer \ Forecastr.Renderer.ASCII )

For example:

Forecastr.forecast(:today, "Berlin")

Forecastr.forecast(:next_days, "Berlin", %{units: :imperial})

Forecastr.forecast(:today, "Lima", %{units: :imperial}, Forecastr.Renderer.PNG)

Link to this section Summary

Link to this section Types

Link to this type

renderer()
renderer() ::
  Forecastr.Renderer.ASCII
  | Forecastr.Renderer.ANSI
  | Forecastr.Renderer.HTML
  | Forecastr.Renderer.JSON
  | Forecastr.Renderer.PNG

Link to this type

when_to_forecast()
when_to_forecast() :: :today | :next_days

Link to this section Functions

Link to this function

forecast(when_to_forecast, query, params \\ %{units: :metric}, renderer \\ Forecastr.Renderer.ASCII)
forecast(when_to_forecast(), query :: String.t(), params :: map(), renderer()) ::
  {:ok, binary()} | {:ok, [binary()]} | {:error, atom()}