dictionaryapi

Documentation

Index

• Variables
• type Client
  • func NewClient(ctx context.Context) Client
  • func (c *Client) Get(word string) (items []WordResponse, err error)
• type Definition
• type Meaning
• type Phonetic
• type WordResponse

Variables

var ErrNotFound = errors.New("word not found")

ErrNotFound is returned when word is not found

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client implements integration with DictionaryAPI docs: https://dictionaryapi.dev/

func NewClient

func NewClient(ctx context.Context) Client

NewClient creates Client with default HTTP client

func (*Client) Get

func (c *Client) Get(word string) (items []WordResponse, err error)

Get returns dictionary item by word

type Definition

type Definition struct {
	Definition string   `json:"definition"`
	Example    string   `json:"example"`
	Synonyms   []string `json:"synonyms"`
	Antonyms   []string `json:"antonyms"`
}

Definition holds information for a definition

type Meaning

type Meaning struct {
	PartOfSpeech string       `json:"partOfSpeech"`
	Definitions  []Definition `json:"definitions"`
}

Meaning holds information for a meaning

type Phonetic

type Phonetic struct {
	Text  string  `json:"text"`
	Audio *string `json:"Audio"`
}

Phonetic holds information for a phonetic pronunciation

type WordResponse

type WordResponse struct {
	Word      string     `json:"word"`
	Phonetic  string     `json:"phonetic"`
	Phonetics []Phonetic `json:"phonetics"`
	Origin    string     `json:"origin"`
	Meanings  []Meaning  `json:"meanings"`
}

WordResponse holds information for an API response