Documentation
¶
Overview ¶
Package weather exposes the US National Weather Service API as a kit Domain driver.
A multi-domain host (ant) enables it with a single blank import:
import _ "github.com/tamnd/weather-cli/weather"
The same Domain also builds the standalone weather binary (see cli.NewApp).
Package weather is the library behind the weather command line: the HTTP client, request shaping, and the typed data models for the US National Weather Service API (api.weather.gov). No API key required.
Index ¶
- Constants
- type Alert
- type Client
- func (c *Client) Alerts(ctx context.Context, state string) ([]Alert, error)
- func (c *Client) Forecast(ctx context.Context, lat, lon float64) ([]Period, error)
- func (c *Client) Hourly(ctx context.Context, lat, lon float64) ([]Period, error)
- func (c *Client) Stations(ctx context.Context, state string, limit int) ([]Station, error)
- type Config
- type Domain
- type Period
- type Station
Constants ¶
const Host = "api.weather.gov"
Host is the API host this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Alert ¶
type Alert struct {
ID string `json:"id"`
Event string `json:"event"`
Severity string `json:"severity"`
Certainty string `json:"certainty"`
Urgency string `json:"urgency"`
Headline string `json:"headline"`
Description string `json:"description,omitempty"`
Instruction string `json:"instruction,omitempty"`
Effective string `json:"effective"`
Expires string `json:"expires"`
}
Alert is an active weather alert.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to the NWS API over HTTP.
func (*Client) Forecast ¶
Forecast fetches the 7-day forecast for the given coordinates. It first calls /points to resolve the forecast URL, then fetches it.
type Config ¶
type Config struct {
BaseURL string
UserAgent string
Rate time.Duration
Timeout time.Duration
Retries int
}
Config holds all tunable parameters for the Client.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns a Config with sensible defaults.
type Domain ¶
type Domain struct{}
Domain is the weather driver.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
type Period ¶
type Period struct {
Number int `json:"number"`
Name string `json:"name"`
StartTime string `json:"startTime"`
EndTime string `json:"endTime"`
IsDaytime bool `json:"isDaytime"`
Temperature int `json:"temperature"`
TemperatureUnit string `json:"temperatureUnit"`
WindSpeed string `json:"windSpeed"`
WindDirection string `json:"windDirection"`
ShortForecast string `json:"shortForecast"`
DetailedForecast string `json:"detailedForecast,omitempty"`
}
Period is one forecast period (half-day or hourly).
Source Files