Skip to main content

Interface: SuggestionResult

Defined in: packages/cspell-trie-lib/dist/index.d.ts:285

Extends​

  • SuggestionResultBase

Properties​

compoundWord?​

optional compoundWord: string

Defined in: packages/cspell-trie-lib/dist/index.d.ts:287

The suggested word with compound marks, generally a •

cost​

cost: number

Defined in: packages/cspell-trie-lib/dist/index.d.ts:278

The edit cost 100 = 1 edit

Inherited from​

SuggestionResultBase.cost

isPreferred?​

optional isPreferred: boolean

Defined in: packages/cspell-trie-lib/dist/index.d.ts:283

This suggestion is the preferred suggestion. Setting this to true implies that an auto fix is possible.

Inherited from​

SuggestionResultBase.isPreferred

word​

word: string

Defined in: packages/cspell-trie-lib/dist/index.d.ts:276

The suggested word

Inherited from​

SuggestionResultBase.word