owm

Documentation

Index

• type Client
  • func NewClient(opts *ClientOptions) *Client
  • func (c *Client) GetWeather(query string, opts *onecall.OneCallOptions) (*GeoDirectOneCallResponse, error)
  • func (c *Client) WithGeo(opts *geo.ClientOptions) *Client
  • func (c *Client) WithOneCall(opts *onecall.ClientOptions) *Client
• type ClientOptions
• type GeoDirectOneCallResponse

Types

type Client

type Client struct {
	OneCall *onecall.Client
	Geo     *geo.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts *ClientOptions) *Client

func (*Client) GetWeather

func (c *Client) GetWeather(query string, opts *onecall.OneCallOptions) (*GeoDirectOneCallResponse, error)

GetWeather is an opinionated convenience function that first performs geocoding and then gets the One Call forecast.

func (*Client) WithGeo

func (c *Client) WithGeo(opts *geo.ClientOptions) *Client

func (*Client) WithOneCall

func (c *Client) WithOneCall(opts *onecall.ClientOptions) *Client

type ClientOptions

type ClientOptions struct {
	HttpClient *http.Client
	AppID      string // Your OpenWeather API key. May also be set as environment variable.
	Logger     *slog.Logger
}

type GeoDirectOneCallResponse

type GeoDirectOneCallResponse struct {
	GeoDirect *geo.GeoData
	OneCall   *onecall.OneCallResponse
}