Documentation
¶
Overview ¶
Package jokeapi is the library behind the jokeapi command line: the HTTP client, request shaping, and the typed data models for v2.jokeapi.dev.
The Client sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load.
Index ¶
Constants ¶
const Host = "v2.jokeapi.dev"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to v2.jokeapi.dev over HTTP.
func (*Client) Categories ¶ added in v0.1.1
Categories returns the list of available joke categories from the API.
func (*Client) Jokes ¶ added in v0.1.1
func (c *Client) Jokes(ctx context.Context, category string, safe bool, count int, blacklist string) ([]Joke, error)
Jokes fetches count jokes from the given category. If safe is true, only family-safe jokes are returned. Category defaults to "Any" if empty. blacklist is a comma-separated list of flags to exclude (nsfw, religious, political, racist, sexist, explicit).
type Config ¶ added in v0.1.1
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 ¶ added in v0.1.1
func DefaultConfig() Config
DefaultConfig returns a Config with sensible defaults.
type Domain ¶
type Domain struct{}
Domain is the jokeapi 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 Joke ¶ added in v0.1.1
type Joke struct {
Rank int `json:"rank"`
ID int `json:"id"`
Category string `json:"category"`
Type string `json:"type"` // "single" or "twopart"
Text string `json:"text"` // for single jokes
Setup string `json:"setup"` // for twopart jokes
Delivery string `json:"delivery"` // for twopart jokes
Safe bool `json:"safe"`
}
Joke is one joke from v2.jokeapi.dev.
Source Files