Documentation
¶
Overview ¶
Package deckofcards is the library behind the deckofcards command line: the HTTP client, request shaping, and the typed data models for deckofcardsapi.com (free, no API key required).
The Client 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 (5xx) that any public API throws under load.
Index ¶
Constants ¶
const Host = "deckofcardsapi.com"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Card ¶
type Card struct {
Code string `json:"code"`
Value string `json:"value"`
Suit string `json:"suit"`
Image string `json:"image"`
}
Card is one card drawn from a deck.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client talks to deckofcardsapi.com over HTTP.
func (*Client) Draw ¶
Draw draws n cards from the deck identified by deckID. n defaults to 1 if <= 0.
type Config ¶
type Config struct {
BaseURL string
UserAgent string
Rate time.Duration
Timeout time.Duration
Retries int
}
Config holds all tuneable parameters for a Client.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns the production configuration for deckofcardsapi.com.
type Deck ¶
type Deck struct {
ID string `json:"deck_id"`
Shuffled bool `json:"shuffled"`
Remaining int `json:"remaining"`
Success bool `json:"success"`
}
Deck represents a deck created or reshuffled via the API.
type Domain ¶
type Domain struct{}
Domain is the deckofcards driver. It carries no state; the per-run client is built by the factory Register hands kit.
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