parser

Documentation

Index

• func GetAllTestEntries(testcasesFilePath string) (map[string][]Entry, error)
• type Entry
  • func ParseDictionaryPage(htmlTextReader io.Reader) ([]Entry, error)
• type QueryResult
  • func (q *QueryResult) FilterByTypes(entryTypes ...string) *QueryResult
• type Sense
• type Spellcheck
  • func ParseSpellcheck(htmlTextReader io.Reader) (*Spellcheck, error)
• type SubSense
• type Suggestion

Functions

func GetAllTestEntries

func GetAllTestEntries(testcasesFilePath string) (map[string][]Entry, error)

Types

type Entry

type Entry struct {
	HyphenatedText string  `yaml:"hyphenatedText"`
	IPA            string  `yaml:"IPA"`
	Type           string  `yaml:"type"`
	GrammerNotes   string  `yaml:"grammerNotes"`
	ExtraInfo      string  `yaml:"extraInfo"`
	Senses         []Sense `yaml:"senses"`
}

func ParseDictionaryPage

func ParseDictionaryPage(htmlTextReader io.Reader) ([]Entry, error)

type QueryResult

type QueryResult struct {
	SpellingIsCorrect bool
	Entries           []Entry  `yaml:"entries"`
	Spellings         []string `yaml:"spellings"`
}

func (*QueryResult) FilterByTypes

func (q *QueryResult) FilterByTypes(entryTypes ...string) *QueryResult

type Sense

type Sense struct {
	SignPost  string     `yaml:"signpost"`
	Subsenses []SubSense `yaml:"subsenses"`
}

type Spellcheck

type Spellcheck struct {
	Suggestions []Suggestion
}

func ParseSpellcheck

func ParseSpellcheck(htmlTextReader io.Reader) (*Spellcheck, error)

type SubSense

type SubSense struct {
	Definition string `yaml:"definition"`
}

type Suggestion

type Suggestion struct {
	Text string
	Url  string
}