Skip to main content

Interface: ValidationIssue

Defined in: packages/cspell-lib/src/lib/Models/ValidationIssue.ts:4

Extends​

  • ValidationResult

Properties​

isFlagged?​

optional isFlagged: boolean

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:5

Inherited from​

ValidationResult.isFlagged

isFound?​

optional isFound: boolean

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:6

Inherited from​

ValidationResult.isFound

issueType?​

optional issueType: IssueType

Defined in: packages/cspell-types/dist/index.d.mts:59

Issues are spelling issues unless otherwise specified.

Inherited from​

ValidationResult.issueType

length?​

optional length: number

Defined in: packages/cspell-types/dist/index.d.mts:17

Assumed to match text.length if the text has not been transformed.

Inherited from​

ValidationResult.length

line​

line: TextOffset

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:4

Inherited from​

ValidationResult.line

message?​

optional message: string

Defined in: packages/cspell-types/dist/index.d.mts:63

Optional message to show.

Inherited from​

ValidationResult.message

offset​

offset: number

Defined in: packages/cspell-types/dist/index.d.mts:13

The offset into the document.

Inherited from​

ValidationResult.offset

suggestions?​

optional suggestions: string[]

Defined in: packages/cspell-lib/src/lib/Models/ValidationIssue.ts:5

suggestionsEx?​

optional suggestionsEx: ExtendedSuggestion[]

Defined in: packages/cspell-lib/src/lib/Models/ValidationIssue.ts:6

text​

text: string

Defined in: packages/cspell-types/dist/index.d.mts:9

The text found at the offset. If the text has been transformed, then the length might not match length. Example: Original: cafe\u0301, text: café

Inherited from​

ValidationResult.text