Brasilapi.Cptec.CityForecast (BrasilAPI v1.0.1)

View Source

Struct representing a city weather forecast. Contains the city information and an array of climate data for multiple days.

Summary

Types

t()

Functions

from_map(map)

Creates a CityForecast struct from a map.

Types

t()

@type t() :: %Brasilapi.Cptec.CityForecast{
  atualizado_em: String.t(),
  cidade: String.t(),
  clima: [Brasilapi.Cptec.ClimateData.t()],
  estado: String.t()
}

Functions

from_map(map)

@spec from_map(map()) :: t()

Creates a CityForecast struct from a map.

Examples

iex> Brasilapi.Cptec.CityForecast.from_map(%{
...>   "cidade" => "São Paulo",
...>   "estado" => "SP",
...>   "atualizado_em" => "2021-01-27",
...>   "clima" => [%{"data" => "2021-01-27", "min" => 18, "max" => 28}]
...> })
%Brasilapi.Cptec.CityForecast{cidade: "São Paulo", estado: "SP", atualizado_em: "2021-01-27", clima: [%Brasilapi.Cptec.ClimateData{...}]}