Langium - v4.0.0
    Preparing search index...

    Type Alias DiagnosticInfo<N, P>

    type DiagnosticInfo<N extends AstNode, P extends string = Properties<N>> = {
        code?: integer | string;
        codeDescription?: CodeDescription;
        data?: unknown;
        index?: number;
        keyword?: string;
        node: N;
        property?: P;
        range?: Range;
        relatedInformation?: DiagnosticRelatedInformation[];
        tags?: DiagnosticTag[];
    }

    Type Parameters

    Index

    Properties

    code? codeDescription? data? index? keyword? node property? range? relatedInformation? tags?

    Properties

    code?: integer | string

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

    codeDescription?: CodeDescription

    An optional property to describe the error code.

    data?: unknown

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

    index?: number

    In case of a multi-value property (array), an index can be given to select a specific element.

    keyword?: string

    If the value of a keyword is given, the diagnostic will appear at its corresponding text region

    node: N

    The AST node to which the diagnostic is attached.

    property?: P

    If a property name is given, the diagnostic is restricted to the corresponding text region.

    range?: Range

    If you want to create a diagnostic independent to any property, use the range property.

    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.

    tags?: DiagnosticTag[]

    Additional metadata about the diagnostic.

    Settings

    Member Visibility

    On This Page

    Properties