Interface: SuggestionOptions

Defined in: packages/cspell-lib/src/lib/suggestions.ts:52

Extends

• FromSuggestOptions

Properties

dictionaries?

optional dictionaries: string[]

Defined in: packages/cspell-lib/src/lib/suggestions.ts:72

List of dictionaries to use. If specified, only that list of dictionaries will be used.

---

includeDefaultConfig?

optional includeDefaultConfig: boolean

Defined in: packages/cspell-lib/src/lib/suggestions.ts:98

By default we want to use the default configuration, but there are cases where someone might not want that.

Default

true

---

includeTies?

optional includeTies: boolean

Defined in: packages/cspell-lib/src/lib/suggestions.ts:91

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

Default

true

Overrides

SuggestOptions.includeTies

---

languageId?

optional languageId: string | string[]

Defined in: packages/cspell-lib/src/lib/suggestions.ts:56

languageId to use when determining file type.

---

locale?

optional locale: string

Defined in: packages/cspell-lib/src/lib/suggestions.ts:61

Locale to use.

---

numChanges?

optional numChanges: number

Defined in: packages/cspell-lib/src/lib/suggestions.ts:84

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

Default

4

Overrides

SuggestOptions.numChanges

---

numSuggestions?

optional numSuggestions: number

Defined in: packages/cspell-lib/src/lib/suggestions.ts:78

The number of suggestions to make.

Default

8

Overrides

SuggestOptions.numSuggestions

---

strict?

optional strict: boolean

Defined in: packages/cspell-lib/src/lib/suggestions.ts:67

Strict case and accent checking

Default

true