Skip to main content

Interface: SuggestedWord

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

Extends​

  • SuggestedWordBase

Properties​

compoundWord?​

optional compoundWord: string

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

The suggested word with compound marks, generally a •

Inherited from​

SuggestedWordBase.compoundWord

cost​

cost: number

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

The edit cost 100 = 1 edit

Inherited from​

SuggestedWordBase.cost

dictionaries​

dictionaries: string[]

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

dictionary names

Inherited from​

SuggestedWordBase.dictionaries

forbidden​

forbidden: boolean

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

isPreferred?​

optional isPreferred: boolean

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

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

Inherited from​

SuggestedWordBase.isPreferred

noSuggest​

noSuggest: boolean

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

word​

word: string

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

The suggested word

Inherited from​

SuggestedWordBase.word

wordAdjustedToMatchCase?​

optional wordAdjustedToMatchCase: string

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

The suggested word adjusted to match the original case.

Inherited from​

SuggestedWordBase.wordAdjustedToMatchCase