Circle V2 API Docs
    Preparing search index...

    Interface Diagnostic

    Describes a problem or hint for a piece of code.

    interface Diagnostic {
        actions?: readonly Action[];
        from: number;
        markClass?: string;
        message: string;
        renderMessage?: (view: EditorView) => Node;
        severity: Severity;
        source?: string;
        to: number;
    }
    Index

    Properties

    actions? from markClass? message renderMessage? severity source? to

    Properties

    actions?: readonly Action[]

    An optional array of actions that can be taken on this diagnostic.

    from: number

    The start position of the relevant text.

    markClass?: string

    When given, add an extra CSS class to parts of the code that this diagnostic applies to.

    message: string

    The message associated with this diagnostic.

    renderMessage?: (view: EditorView) => Node

    An optional custom rendering function that displays the message as a DOM node.

    severity: Severity

    The severity of the problem. This will influence how it is displayed.

    source?: string

    An optional source string indicating where the diagnostic is coming from. You can put the name of your linter here, if applicable.

    to: number

    The end position. May be equal to from, though actually covering text is preferable.

    Settings

    Member Visibility

    On This Page

    Properties