Interface: SuggestOptions

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:2

Properties

optional compoundMethod?: CompoundWordsMethod

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:7

Compounding Mode. NONE is the best option.

optional ignoreCase?: boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:20

Allow for case-ingestive checking.

optional includeTies?: boolean

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:26

If multiple suggestions have the same edit / change "cost", then included them even if it causes more than numSuggestions to be returned.

false

optional numChanges?: number

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:16

Max number of changes / edits to the word to get to a suggestion matching suggestion.

optional numSuggestions?: number

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:12

The limit on the number of suggestions to generate. If allowTies is true, it is possible for more suggestions to be generated.

optional timeout?: number

Defined in: packages/cspell-dictionary/dist/SpellingDictionary/SuggestOptions.d.ts:30

Maximum amount of time in milliseconds to allow for generating suggestions.