Interface Diagnostic

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.

interface Diagnostic {
    code?: string | number;
    codeDescription?: CodeDescription;
    data?: any;
    message: string;
    range: Range;
    relatedInformation?: DiagnosticRelatedInformation[];
    severity?: DiagnosticSeverity;
    source?: string;
    tags?: DiagnosticTag[];
}

Properties

code? codeDescription? data? message range relatedInformation? severity? source? tags?

Properties

Optionalcode

code?: string | number

The diagnostic's code, which usually appear in the user interface.

OptionalcodeDescription

codeDescription?: CodeDescription

An optional property to describe the error code. Requires the code field (above) to be present/not null.

Since

3.16.0

Optionaldata

data?: any

A data entry field that is preserved between a textDocument/publishDiagnostics notification and textDocument/codeAction request.

Since

3.16.0

message

message: string

The diagnostic's message. It usually appears in the user interface

range

range: Range

The range at which the message applies

OptionalrelatedInformation

relatedInformation?: DiagnosticRelatedInformation[]

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

Optionalseverity

severity?: DiagnosticSeverity

The diagnostic's severity. To avoid interpretation mismatches when a server is used with different clients it is highly recommended that servers always provide a severity value.

Optionalsource

source?: string

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.

Optionaltags

tags?: DiagnosticTag[]

Additional metadata about the diagnostic.

Since

3.15.0

Settings

Member Visibility

On This Page

Properties