airmatters

Documentation

Index

• Variables
• type AirMatters
  • func New(key string) *AirMatters
  • func (api *AirMatters) Coordinates(query string) (coordinates.Coordinates, error)
  • func (api *AirMatters) Forecast(aqiType aqi.Type, query string, _ int) (days []aqi.Day, err error)
  • func (api *AirMatters) History(aqiType aqi.Type, query string, t time.Time) (aqi.Day, error)
  • func (api *AirMatters) Places(query string) ([]Place, error)
  • func (api *AirMatters) Realtime(aqiType aqi.Type, query string) (aqi.Current, error)
  • func (api *AirMatters) RealtimeNearby(aqiType aqi.Type, query coordinates.Coordinates) (Place, aqi.Current, error)
  • func (api *AirMatters) Request(endpoint string, query url.Values, data any) error
  • func (api *AirMatters) Standard(t aqi.Type) ([]aqi.AQI, error)
• type Current
  • func (i Current) AQI() aqi.AQI
  • func (i Current) Date() string
  • func (i Current) Pollutants() (pollutants []aqi.Pollutant)
  • func (i Current) Unix() unit.UnixTime
• type Item
  • func (i Item) AQI() aqi.AQI
  • func (i Item) Date() string
  • func (i Item) Unix() unit.UnixTime
• type Place
• type Standard
  • func (standard Standard) Standard() (res []aqi.AQI)
  • func (standard Standard) Type() aqi.Type

Variables

var PlaceMap sync.Map

Types

type AirMatters

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

func New

func New(key string) *AirMatters

func (*AirMatters) Coordinates

func (api *AirMatters) Coordinates(query string) (coordinates.Coordinates, error)

func (*AirMatters) Forecast

func (api *AirMatters) Forecast(aqiType aqi.Type, query string, _ int) (days []aqi.Day, err error)

func (*AirMatters) History

func (api *AirMatters) History(aqiType aqi.Type, query string, t time.Time) (aqi.Day, error)

func (*AirMatters) Places

func (api *AirMatters) Places(query string) ([]Place, error)

func (*AirMatters) Realtime

func (api *AirMatters) Realtime(aqiType aqi.Type, query string) (aqi.Current, error)

func (*AirMatters) RealtimeNearby

func (api *AirMatters) RealtimeNearby(aqiType aqi.Type, query coordinates.Coordinates) (Place, aqi.Current, error)

func (*AirMatters) Request

func (api *AirMatters) Request(endpoint string, query url.Values, data any) error

func (*AirMatters) Standard

func (api *AirMatters) Standard(t aqi.Type) ([]aqi.AQI, error)

type Current

type Current struct {
	AQIType aqi.Type
	Time    string `json:"update_time,omitempty"`
	Items   []Item `json:"readings,omitempty"`
}

func (Current) AQI

func (i Current) AQI() aqi.AQI

func (Current) Date

func (i Current) Date() string

func (Current) Pollutants

func (i Current) Pollutants() (pollutants []aqi.Pollutant)

func (Current) Unix

func (i Current) Unix() unit.UnixTime

type Item

type Item struct {
	AQIType aqi.Type
	Color   string `json:"color,omitempty"`
	Kind    string `json:"kind,omitempty"`
	Level   string `json:"level,omitempty"`
	Name    string `json:"name,omitempty"`
	Type    string `json:"type,omitempty"`
	Value   string `json:"value,omitempty"`
	Unit    string `json:"unit,omitempty"`
	Time    string `json:"time,omitempty"`
}

func (Item) AQI

func (i Item) AQI() aqi.AQI

func (Item) Date

func (i Item) Date() string

func (Item) Unix

func (i Item) Unix() unit.UnixTime

type Place

type Place struct {
	ID          string  `json:"place_id,omitempty"`
	Type        string  `json:"type,omitempty"`
	Name        string  `json:"name,omitempty"`
	Description string  `json:"description,omitempty"`
	Latitude    float64 `json:"lat,omitempty"`
	Longitude   float64 `json:"lon,omitempty"`
}

type Standard

type Standard struct {
	BreakPoint map[string]struct{ AQI []int } `json:"break_point,omitempty"`
	Levels     map[string][]string            `json:"levels,omitempty"`
	Color      map[string][]string            `json:"color,omitempty"`
}

func (Standard) Standard

func (standard Standard) Standard() (res []aqi.AQI)

func (Standard) Type

func (standard Standard) Type() aqi.Type