Skip to main content

Interface: TraceResult

Defined in: packages/cspell-lib/dist/lib/trace.d.ts:5

Extends​

  • DictionaryTraceResult

Properties​

configSource​

configSource: string | undefined

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:21

href to the config file referencing the dictionary.

Inherited from​

DictionaryTraceResult.configSource

dictActive​

dictActive: boolean

Defined in: packages/cspell-lib/dist/lib/trace.d.ts:7

True if the dictionary is currently active.

dictBlocked​

dictBlocked: boolean

Defined in: packages/cspell-lib/dist/lib/trace.d.ts:9

True if the dictionary is blocked from use.

dictName​

dictName: string

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:15

The name of the dictionary.

Inherited from​

DictionaryTraceResult.dictName

dictSource​

dictSource: string

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:17

The path/href to dictionary file.

Inherited from​

DictionaryTraceResult.dictSource

errors?​

optional errors?: Error[]

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:23

Errors

Inherited from​

DictionaryTraceResult.errors

forbidden​

forbidden: boolean

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:11

Indicates that the word is flagged.

Inherited from​

DictionaryTraceResult.forbidden

found​

found: boolean

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:7

Inherited from​

DictionaryTraceResult.found

foundWord​

foundWord: string | undefined

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:9

The word found.

Inherited from​

DictionaryTraceResult.foundWord

noSuggest​

noSuggest: boolean

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:13

The would should not show up in suggestions, but is considered correct.

Inherited from​

DictionaryTraceResult.noSuggest

preferredSuggestions?​

optional preferredSuggestions?: string[]

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:19

Suggested changes to the word.

Inherited from​

DictionaryTraceResult.preferredSuggestions

word​

word: string

Defined in: packages/cspell-lib/dist/lib/textValidation/traceWord.d.ts:6

The word being traced.

Inherited from​

DictionaryTraceResult.word