@mermaid-lint/core
    Preparing search index...

    Interface Block

    A single Mermaid diagram extracted from a source document, with the location of its opening fence and the raw diagram body.

    interface Block {
        body: string;
        col: number;
        fileDirectives?: readonly Directive[];
        line: number;
        path: string;
        type: string;
    }
    Index

    Properties

    body col fileDirectives? line path type

    Properties

    body

    body: string

    Raw diagram source. For indented fences, body lines retain the source indentation prefix. The sentinel '__UNCLOSED_FENCE__' marks a fence with no closing marker.

    col: number

    1-indexed column of the opening fence.

    fileDirectives?: readonly Directive[]

    Document-level suppression directives (<!-- mermaid-lint-disable-file -->) found anywhere in the source document. Attached at extraction so every integration that uses this extractor gets file scope without threading the document text separately. Hand-built blocks (remark, textlint) populate this themselves; omitting it just means file scope does not apply.

    line: number

    1-indexed line of the opening fence (or line 1 for whole-file .mmd).

    path: string

    Source file path the block came from.

    type: string

    Detected diagram type (e.g. 'flowchart', 'sequenceDiagram', 'unknown'). The value '---' is a meaningful sentinel rather than a diagram type — see detectDiagramType.

    Settings

    Member Visibility

    On This Page

    Properties