oxford

Documentation

Overview

Package oxford provides a dictionary source via the Oxford Dictionaries API

Index

• Constants
• func New(httpClient http.Client, appID, appKey string) source.Source
• type RequiredConfigError
  • func (e *RequiredConfigError) Error() string

Constants

const JSONKey = "OxfordDictionary"

JSONKey defines the JSON key used for the provider

const Name = "Oxford Dictionaries API"

Name defines the name of the source

Functions

func New

func New(httpClient http.Client, appID, appKey string) source.Source

New returns a new Oxford API dictionary source

Types

type RequiredConfigError

type RequiredConfigError struct {
	Key string
}

RequiredConfigError represents an error when a required configuration key is missing or invalid.

func (*RequiredConfigError) Error

func (e *RequiredConfigError) Error() string