Skip to main content

Interface: TraceResult

Defined in: packages/cspell-lib/src/lib/trace.ts:23

Extends​

  • DictionaryTraceResult

Properties​

configSource​

configSource: string | undefined

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

href to the config file referencing the dictionary.

Inherited from​

DictionaryTraceResult.configSource

dictActive​

dictActive: boolean

Defined in: packages/cspell-lib/src/lib/trace.ts:25

True if the dictionary is currently active.

dictBlocked​

dictBlocked: boolean

Defined in: packages/cspell-lib/src/lib/trace.ts:27

True if the dictionary is blocked from use.

dictName​

dictName: string

Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:34

The name of the dictionary.

Inherited from​

DictionaryTraceResult.dictName

dictSource​

dictSource: string

Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:36

The path/href to dictionary file.

Inherited from​

DictionaryTraceResult.dictSource

errors?​

optional errors?: Error[]

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

Errors

Inherited from​

DictionaryTraceResult.errors

forbidden​

forbidden: boolean

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

Indicates that the word is flagged.

Inherited from​

DictionaryTraceResult.forbidden

found​

found: boolean

Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:26

Inherited from​

DictionaryTraceResult.found

foundWord​

foundWord: string | undefined

Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:28

The word found.

Inherited from​

DictionaryTraceResult.foundWord

noSuggest​

noSuggest: boolean

Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:32

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/src/lib/textValidation/traceWord.ts:38

Suggested changes to the word.

Inherited from​

DictionaryTraceResult.preferredSuggestions

word​

word: string

Defined in: packages/cspell-lib/src/lib/textValidation/traceWord.ts:25

The word being traced.

Inherited from​

DictionaryTraceResult.word