Brasilapi.Cptec.OceanForecast (BrasilAPI v1.0.1)

View Source

Struct representing an ocean/wave forecast for a city. Contains the city information and an array of daily wave data.

Summary

Types

t()

Functions

from_map(map)

Creates an OceanForecast struct from a map.

Types

t()

@type t() :: %Brasilapi.Cptec.OceanForecast{
  atualizado_em: String.t(),
  cidade: String.t(),
  estado: String.t(),
  ondas: [Brasilapi.Cptec.DailyWaves.t()]
}

Functions

from_map(map)

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

Creates an OceanForecast struct from a map.

Examples

iex> Brasilapi.Cptec.OceanForecast.from_map(%{
...>   "cidade" => "Rio de Janeiro",
...>   "estado" => "RJ",
...>   "atualizado_em" => "2021-01-27",
...>   "ondas" => [%{"data" => "2021-01-27", "ondas_data" => []}]
...> })
%Brasilapi.Cptec.OceanForecast{cidade: "Rio de Janeiro", estado: "RJ", atualizado_em: "2021-01-27", ondas: [%Brasilapi.Cptec.DailyWaves{...}]}