weatherapi

Documentation

Overview

Package weatherapi provides a client for the WeatherAPI.com API.

Index

• type Client
  • func NewClient(key string) *Client
  • func (c *Client) GetCurrent(ctx context.Context, opts ...QueryOption) (res *Current, err error)
• type Condition
• type Current
• type Error
• type ErrorResp
  • func (er *ErrorResp) Error() string
• type Location
• type QueryOption
  • func WithAutoIP() QueryOption
  • func WithCity(city string) QueryOption
  • func WithUSZip(zip string) QueryOption
• type Weather

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(key string) *Client

func (*Client) GetCurrent

func (c *Client) GetCurrent(ctx context.Context, opts ...QueryOption) (res *Current, err error)

type Condition

type Condition struct {
	Text string `json:"text"`
	Icon string `json:"icon"`
	Code int    `json:"code"`
}

type Current

type Current struct {
	Location Location
	Current  Weather
}

type Error

type Error struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

type ErrorResp

type ErrorResp struct {
	StatusCode int   // The HTTP status code.
	Err        Error `json:"error"`
}

func (*ErrorResp) Error

func (er *ErrorResp) Error() string

type Location

type Location struct {
	Name           string  `json:"name"`
	Region         string  `json:"region"`
	Country        string  `json:"country"`
	Lat            float64 `json:"lat"`
	Lon            float64 `json:"lon"`
	TzID           string  `json:"tz_id"`
	LocaltimeEpoch int     `json:"localtime_epoch"`
	Localtime      string  `json:"localtime"`
}

type QueryOption

type QueryOption func(*query)

func WithAutoIP

func WithAutoIP() QueryOption

func WithCity

func WithCity(city string) QueryOption

func WithUSZip

func WithUSZip(zip string) QueryOption

type Weather

type Weather struct {
	LastUpdatedEpoch int       `json:"last_updated_epoch"`
	LastUpdated      string    `json:"last_updated"`
	TempC            float64   `json:"temp_c"`
	TempF            float64   `json:"temp_f"`
	IsDay            int       `json:"is_day"`
	Condition        Condition `json:"condition"`
	WindMPH          float64   `json:"wind_mph"`
	WindKPH          float64   `json:"wind_kph"`
	WindDegree       int       `json:"wind_degree"`
	WindDir          string    `json:"wind_dir"`
	PressureMB       float64   `json:"pressure_mb"`
	PressureIN       float64   `json:"pressure_in"`
	PrecipMM         float64   `json:"precip_mm"`
	PrecipIN         float64   `json:"precip_in"`
	Humidity         int       `json:"humidity"`
	Cloud            int       `json:"cloud"`
	FeelslikeC       float64   `json:"feelslike_c"`
	FeelslikeF       float64   `json:"feelslike_f"`
	WindchillC       float64   `json:"windchill_c"`
	WindchillF       float64   `json:"windchill_f"`
	HeatindexC       float64   `json:"heatindex_c"`
	HeatindexF       float64   `json:"heatindex_f"`
	DewpointC        float64   `json:"dewpoint_c"`
	DewpointF        float64   `json:"dewpoint_f"`
	VisKM            float64   `json:"vis_km"`
	VisMiles         float64   `json:"vis_miles"`
	UV               float64   `json:"uv"`
	GustMPH          float64   `json:"gust_mph"`
	GustKPH          float64   `json:"gust_kph"`
}