Documentation
¶
Overview ¶
Package opennotify is the library behind the opennotify command line: the HTTP client, request shaping, and the typed data models for the Open Notify API (api.open-notify.org).
The API is completely open: no authentication, no API key. It exposes two endpoints — the current ISS position and the list of people in space. The API is HTTP-only; HTTPS is not supported.
Index ¶
Constants ¶
const Host = "api.open-notify.org"
Host is the API hostname.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to the Open Notify API over HTTP.
func (*Client) Astronauts ¶
Astronauts returns all humans currently in space.
type Config ¶
type Config struct {
BaseURL string
UserAgent string
Rate time.Duration // minimum gap between consecutive HTTP requests
Timeout time.Duration // per-request HTTP timeout
Retries int // maximum retry attempts on transient errors
}
Config holds all tunable parameters for the Client.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns a Config with sensible defaults for the Open Notify API.
type Domain ¶
type Domain struct{}
Domain is the opennotify 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.
Source Files