Interface Diagnostic

interface Diagnostic {
    category: 0 | 1 | 2 | 3;
    code: number;
    file: undefined | {
        fileName: string;
    };
    length: undefined | number;
    messageText: string | DiagnosticMessageChain;
    relatedInformation?: DiagnosticRelatedInformation[];
    reportsDeprecated?: {};
    reportsUnnecessary?: {};
    source?: string;
    start: undefined | number;
}

Hierarchy (view full)

Properties

category code file length messageText relatedInformation? reportsDeprecated? reportsUnnecessary? source? start

Properties

category

category: 0 | 1 | 2 | 3

Diagnostic category: warning = 0, error = 1, suggestion = 2, message = 3

code

code: number

file

file: undefined | {
    fileName: string;
}

TypeScriptWorker removes all but the fileName property to avoid serializing circular JSON structures.

Type declaration

  • fileName: string

length

length: undefined | number

messageText

messageText: string | DiagnosticMessageChain

Optional relatedInformation

relatedInformation?: DiagnosticRelatedInformation[]

Optional reportsDeprecated

reportsDeprecated?: {}

Type declaration

    Optional reportsUnnecessary

    reportsUnnecessary?: {}

    May store more in future. For now, this will simply be true to indicate when a diagnostic is an unused-identifier diagnostic.

    Type declaration

      Optional source

      source?: string

      start

      start: undefined | number

      Settings

      Member Visibility

      Theme

      On This Page

      categorycodefilelengthmessageTextrelatedInformationreportsDeprecatedreportsUnnecessarysourcestart