Skip to main content

Interface: Issue

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

Extends​

Properties​

col​

col: number

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

Inherited from​

Omit.col

context​

context: TextOffset

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

text surrounding the issue text

isFlagged?​

optional isFlagged: boolean

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

true if the issue has been flagged as a forbidden word.

issueType?​

optional issueType: IssueType

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

Issues are spelling issues unless otherwise specified.

length?​

optional length: number

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

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

Inherited from​

Omit.length

line​

line: TextOffset

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

Inherited from​

Omit.line

message?​

optional message: string

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

Optional message to show.

offset​

offset: number

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

The offset into the document.

Inherited from​

Omit.offset

row​

row: number

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

Inherited from​

Omit.row

suggestions?​

optional suggestions: string[]

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

An optional array of replacement strings.

suggestionsEx?​

optional suggestionsEx: Suggestion[]

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

An optional array of suggestions.

text​

text: string

Defined in: 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​

Omit.text

uri?​

optional uri: string

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

Inherited from​

Omit.uri