Documentation
¶
Overview ¶
Package dnd5e is the library behind the dnd5e command line: the HTTP client, request shaping, and the typed data models for the D&D 5th Edition API (www.dnd5eapi.co).
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public API throws under load. Build your endpoint calls and JSON decoding on top of it.
Index ¶
- Constants
- type Class
- type Client
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) GetMonster(ctx context.Context, index string) (*Monster, error)
- func (c *Client) GetSpell(ctx context.Context, index string) (*Spell, error)
- func (c *Client) ListClasses(ctx context.Context) ([]ListItem, error)
- func (c *Client) ListMonsters(ctx context.Context, limit int) ([]ListItem, error)
- func (c *Client) ListSpells(ctx context.Context, limit int) ([]ListItem, error)
- type Domain
- type ListItem
- type Monster
- type Spell
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "dnd5e/dev (+https://github.com/tamnd/dnd5e-cli)"
DefaultUserAgent identifies the client to the D&D 5e API.
const Host = "www.dnd5eapi.co"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Class ¶
type Class struct {
Index string `kit:"id" json:"index"`
Name string `json:"name"`
HitDie int `json:"hit_die"`
}
Class holds the brief record for a D&D 5e character class.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to the D&D 5e API over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 200ms minimum gap between requests, and five retries on transient errors.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings. The caller owns nothing extra; the body is read fully and closed here.
func (*Client) GetMonster ¶
GetMonster fetches full stats for a single monster by its index.
func (*Client) ListClasses ¶
ListClasses returns all character classes.
func (*Client) ListMonsters ¶
ListMonsters returns a list of all monsters, truncated to limit items.
type Domain ¶
type Domain struct{}
Domain is the dnd5e driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input into the canonical (type, id), so `ant resolve` and `ant url` need no network.
Heuristic: if the id matches a known class name → class; otherwise → spell (spells are far more numerous and include both all-letter names like "fireball" and hyphenated names like "cure-wounds").
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 ListItem ¶
type ListItem struct {
Index string `kit:"id" json:"index"`
Name string `json:"name"`
URL string `json:"url"`
}
ListItem is a brief record returned by list endpoints.
type Monster ¶
type Monster struct {
Index string `kit:"id" json:"index"`
Name string `json:"name"`
Size string `json:"size"`
Type string `json:"type"`
Alignment string `json:"alignment"`
HitPoints int `json:"hit_points"`
ArmorClass int `json:"armor_class"`
ChallengeRating float64 `json:"challenge_rating"`
Strength int `json:"strength"`
Dexterity int `json:"dexterity"`
Constitution int `json:"constitution"`
Intelligence int `json:"intelligence"`
Wisdom int `json:"wisdom"`
Charisma int `json:"charisma"`
}
Monster holds the stat block for a single D&D 5e monster.
type Spell ¶
type Spell struct {
Index string `kit:"id" json:"index"`
Name string `json:"name"`
Level int `json:"level"`
School string `json:"school_name"`
CastingTime string `json:"casting_time"`
Range string `json:"range"`
Duration string `json:"duration"`
Description []string `json:"desc"`
Components []string `json:"components"`
Classes []string `json:"class_names"`
}
Spell holds the details for a single D&D 5e spell.
Source Files