shared

Documentation

Index

• Variables
• type DictionaryEntry
• type DictionaryType
• type EntryType

Variables

var (
	// DictionaryNames returns the list of available dictionaries.
	DictionaryNames = func() []string {
		return []string{
			string(search.Stopwords),
			string(search.Compounds),
			string(search.Plurals),
		}
	}
)

Types

type DictionaryEntry

type DictionaryEntry struct {
	Type          EntryType
	Word          string   `json:"word,omitempty"`
	Words         []string `json:"words,omitempty"`
	Decomposition []string `json:"decomposition,omitempty"`
	ObjectID      string
	Language      string
	State         string
}

DictionaryEntry can be plural, compound or stopword entry.

type DictionaryType

type DictionaryType int

type EntryType

type EntryType string

EntryType represents the type of an entry in a dictionary. It can be either a custom entry or a standard entry.

const (
	// CustomEntryType is the type of a custom entry in a dictionary (i.e. added by the user).
	CustomEntryType EntryType = "custom"
	// StandardEntryType is the type of a standard entry in a dictionary (i.e. added by Algolia).
	StandardEntryType EntryType = "standard"
)