Documentation
¶
Overview ¶
Package jisho is the library behind the jisho command line: the HTTP client, request shaping, and the typed data models for the Jisho Japanese dictionary (jisho.org).
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 site throws under load.
Index ¶
- Constants
- type Client
- func (c *Client) Get(ctx context.Context, rawURL string) ([]byte, error)
- func (c *Client) LookupKanji(ctx context.Context, char string) ([]*Word, error)
- func (c *Client) RandomWord(ctx context.Context) ([]*Word, error)
- func (c *Client) SearchWords(ctx context.Context, query string, page int) ([]*Word, error)
- type Config
- type Domain
- type Word
Constants ¶
const BaseURL = "https://jisho.org/api/v1"
BaseURL is the API root every request is built from.
const DefaultUserAgent = "jisho-cli/0.1 (tamnd87@gmail.com)"
DefaultUserAgent identifies the client to jisho.
const Host = "jisho.org"
Host is the site this client talks to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
BaseURL 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 jisho.org over HTTP.
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings.
func (*Client) LookupKanji ¶
LookupKanji looks up a kanji character using the #kanji tag.
func (*Client) RandomWord ¶
RandomWord fetches a random vocabulary word.
type Config ¶
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 ¶
func DefaultConfig() Config
DefaultConfig returns a Config with sensible defaults.
type Domain ¶
type Domain struct{}
Domain is the jisho 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.
type Word ¶
type Word struct {
Slug string `json:"slug" kit:"id"`
Word string `json:"word"`
Reading string `json:"reading"`
IsCommon bool `json:"is_common"`
JLPT []string `json:"jlpt"`
Tags []string `json:"tags"`
Definitions []string `json:"definitions"`
PartsOfSpeech []string `json:"parts_of_speech"`
}
Word is the canonical output record for a single dictionary entry.
Source Files