openweathermap

Documentation

Overview

Package openweathermap provides weather using the OpenWeatherMap API, available at https://openweathermap.org/api.

Index

• type Config
  • func New(apiKey string) Config
  • func (c Config) CityID(cityID string) weather.Provider
  • func (c Config) CityName(city, country string) weather.Provider
  • func (c Config) Coords(lat, lon float64) weather.Provider
  • func (c Config) Zipcode(zip, country string) weather.Provider
• type Provider
  • func (owm Provider) GetWeather() (weather.Weather, error)

Types

type Config

type Config string

Config represents open weather map API configuration (just the API key) from which a weather.Provider can be built.

func New

func New(apiKey string) Config

New creates a new OpenWeatherMap API configuration.

func (Config) CityID

func (c Config) CityID(cityID string) weather.Provider

CityID queries OWM by city id. Recommended.

func (Config) CityName

func (c Config) CityName(city, country string) weather.Provider

CityName queries OWM using a named city. Least accurate.

func (Config) Coords

func (c Config) Coords(lat, lon float64) weather.Provider

Coords queries OWM using lat/lon co-ordinates.

func (Config) Zipcode

func (c Config) Zipcode(zip, country string) weather.Provider

Zipcode queries OWM using a zip code or post code and country.

type Provider

type Provider string

Provider wraps an open weather map API url so that it can be used as a weather.Provider.

func (Provider) GetWeather

func (owm Provider) GetWeather() (weather.Weather, error)

GetWeather gets weather information from OpenWeatherMap.