Skip to main content

Interface: SuggestionsConfiguration

Defined in: packages/cspell-types/dist/index.d.mts:61

Extended by​

Properties​

numSuggestions?​

optional numSuggestions?: number

Defined in: packages/cspell-types/dist/index.d.mts:67

Number of suggestions to make.

Default​

10

suggestionNumChanges?​

optional suggestionNumChanges?: number

Defined in: packages/cspell-types/dist/index.d.mts:83

The maximum number of changes allowed on a word to be considered a suggestions.

For example, appending an s onto example -> examples is considered 1 change.

Range: between 1 and 5.

Default​

3

suggestionsTimeout?​

optional suggestionsTimeout?: number

Defined in: packages/cspell-types/dist/index.d.mts:73

The maximum amount of time in milliseconds to generate suggestions for a word.

Default​

500