A Dictionary is used to define, add/remove patterns to/from, and generate suggestions from suggestion scopes. As someone using this library, the Dictionary class will likely be the primary interface between your code and the functionality autosuggestion has to offer.

Generally speaking, a Dictionary is a collection of named [[Trie|scopes]] containing patterns (words or phrases) which can be easily matched with partially completed input patterns ¹. For example, if we want to generate suggestions based on a list of colors, we can

// create a new dictionary
const myDictionary = new Dictionary()

// define a named context with some colors
myDictionary.define('myColors', ['red', 'rose', 'pink'])

now, we can generate suggestions given input,

const inputText = 'r'

// match input text with potential completions in the 'myColors' context
const colorSuggestions = myDictionary.suggest(inputText, 'myColors')
// outputs: red, rose

If we don't know all the patterns for a scope upfront, we can dynamically add,

myDictionary.add('myColors', ['salmon', 'violet', 'avocado'])

or remove,

myDictionary.remove('myColors', ['red', 'salmon'])

---