Show / Hide Table of Contents

    Class DiagnosticMessages

    Package: grammarkdown

    Constructors

    constructor(lineOffsetMap)

    Constructs a new instance of the DiagnosticMessages class

    Declaration
    constructor(lineOffsetMap?: LineOffsetMap);
    Parameters
    lineOffsetMap
    LineOffsetMap

    Properties

    size

    Declaration
    get size(): number;
    Property Value
    number

    Methods

    [Symbol.iterator]()

    Declaration
    [Symbol.iterator](): Generator<DiagnosticInfo | undefined, void, unknown>;
    Returns
    Generator<DiagnosticInfo | undefined, void, unknown>

    copyFrom(other)

    Declaration
    copyFrom(other: DiagnosticMessages): void;
    Parameters
    other
    DiagnosticMessages

    Returns
    void

    count()

    Declaration
    count(): number;
    Returns
    number

    forEach(callback)

    Declaration
    forEach(callback: (message: string, diagnosticIndex: number) => void): void;
    Parameters
    callback
    (message: string, diagnosticIndex: number) => void

    Returns
    void

    getDiagnostic(diagnosticIndex)

    Declaration
    getDiagnostic(diagnosticIndex: number): Diagnostic | undefined;
    Parameters
    diagnosticIndex
    number

    Returns
    Diagnostic | undefined

    getDiagnosticArguments(diagnosticIndex)

    Declaration
    getDiagnosticArguments(diagnosticIndex: number): any[] | undefined;
    Parameters
    diagnosticIndex
    number

    Returns
    any[] | undefined

    getDiagnosticFilename(diagnosticIndex, raw)

    Declaration
    getDiagnosticFilename(diagnosticIndex: number, raw?: boolean): string | undefined;
    Parameters
    diagnosticIndex
    number

    raw
    boolean

    Returns
    string | undefined

    getDiagnosticInfo(diagnosticIndex, options)

    Declaration
    getDiagnosticInfo(diagnosticIndex: number, options?: {
            formatMessage?: boolean;
            detailedMessage?: boolean;
            raw?: boolean;
        }): DiagnosticInfo | undefined;
    Parameters
    diagnosticIndex
    number

    options
    { formatMessage?: boolean; detailedMessage?: boolean; raw?: boolean; }

    Returns
    DiagnosticInfo | undefined

    getDiagnosticInfos(options)

    Declaration
    getDiagnosticInfos(options?: {
            formatMessage?: boolean;
            detailedMessage?: boolean;
            raw?: boolean;
        }): DiagnosticInfo[];
    Parameters
    options
    { formatMessage?: boolean; detailedMessage?: boolean; raw?: boolean; }

    Returns
    DiagnosticInfo[]

    getDiagnosticInfosForSourceFile(sourceFile, options)

    Declaration
    getDiagnosticInfosForSourceFile(sourceFile: SourceFile, options?: {
            formatMessage?: boolean;
            detailedMessage?: boolean;
            raw?: boolean;
        }): DiagnosticInfo[];
    Parameters
    sourceFile
    SourceFile

    options
    { formatMessage?: boolean; detailedMessage?: boolean; raw?: boolean; }

    Returns
    DiagnosticInfo[]

    getDiagnosticNode(diagnosticIndex)

    Declaration
    getDiagnosticNode(diagnosticIndex: number): Node | undefined;
    Parameters
    diagnosticIndex
    number

    Returns
    Node | undefined

    getDiagnosticPosition(diagnosticIndex, raw)

    Declaration
    getDiagnosticPosition(diagnosticIndex: number, raw?: boolean): Position | undefined;
    Parameters
    diagnosticIndex
    number

    raw
    boolean

    Returns
    Position | undefined

    getDiagnosticRange(diagnosticIndex, raw)

    Declaration
    getDiagnosticRange(diagnosticIndex: number, raw?: boolean): Range | undefined;
    Parameters
    diagnosticIndex
    number

    raw
    boolean

    Returns
    Range | undefined

    getDiagnosticSourceFile(diagnosticIndex)

    Declaration
    getDiagnosticSourceFile(diagnosticIndex: number): SourceFile | undefined;
    Parameters
    diagnosticIndex
    number

    Returns
    SourceFile | undefined

    getMessage(diagnosticIndex, options)

    Declaration
    getMessage(diagnosticIndex: number, options?: {
            detailed?: boolean;
            raw?: boolean;
        }): string;
    Parameters
    diagnosticIndex
    number

    options
    { detailed?: boolean; raw?: boolean; }

    Returns
    string

    report(pos, message, args)

    Declaration
    report(pos: number, message: Diagnostic, ...args: any[]): void;
    Parameters
    pos
    number

    message
    Diagnostic

    args
    any[]

    Returns
    void

    reportNode(sourceFile, node, message, args)

    Declaration
    reportNode(sourceFile: SourceFile | undefined, node: Node, message: Diagnostic, ...args: any[]): void;
    Parameters
    sourceFile
    SourceFile | undefined

    node
    Node

    message
    Diagnostic

    args
    any[]

    Returns
    void

    setSourceFile(sourceFile)

    Declaration
    setSourceFile(sourceFile: SourceFile): void;
    Parameters
    sourceFile
    SourceFile

    Returns
    void

    values()

    Declaration
    values(): Generator<DiagnosticInfo | undefined, void, unknown>;
    Returns
    Generator<DiagnosticInfo | undefined, void, unknown>

    Back to top Generated by DocFX