Interface: TraceResult
Defined in: packages/cspell-lib/src/lib/trace.ts:17
Extends
DictionaryTraceResult
Properties
configSource
configSource:
undefined|string
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:39
href to the config file referencing the dictionary.
Inherited from
DictionaryTraceResult.configSource
dictActive
dictActive:
boolean
Defined in: packages/cspell-lib/src/lib/trace.ts:19
True if the dictionary is currently active.
dictName
dictName:
string
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:33
The name of the dictionary.
Inherited from
DictionaryTraceResult.dictName
dictSource
dictSource:
string
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:35
The path/href to dictionary file.
Inherited from
DictionaryTraceResult.dictSource
errors?
optionalerrors:Error[]
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:41
Errors
Inherited from
DictionaryTraceResult.errors
forbidden
forbidden:
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:29
Indicates that the word is flagged.
Inherited from
DictionaryTraceResult.forbidden
found
found:
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:25
Inherited from
DictionaryTraceResult.found
foundWord
foundWord:
undefined|string
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:27
The word found.
Inherited from
DictionaryTraceResult.foundWord
noSuggest
noSuggest:
boolean
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:31
The would should not show up in suggestions, but is considered correct.
Inherited from
DictionaryTraceResult.noSuggest
preferredSuggestions?
optionalpreferredSuggestions:string[]
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:37
Suggested changes to the word.
Inherited from
DictionaryTraceResult.preferredSuggestions
word
word:
string
Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:24
The word being traced.
Inherited from
DictionaryTraceResult.word