@eagleoutice/flowr/util/mermaid/mermaid.d.ts

Static Dataflow Analyzer and Program Slicer for the R Programming Language

/**
 * Global mermaid helper object with useful functions.
 */
export declare const Mermaid: {
    readonly name: "Mermaid";
    /**
     * Replacements applied by escape functions!
     */
    readonly replacements: {
        readonly '\\n': "\n";
        readonly '`': "#96;";
        readonly '[': "#91;";
        readonly ']': "#93;";
        readonly '<': "#60;";
        readonly '>': "#62;";
        readonly '*': "#42;";
        readonly '+': "#43;";
        readonly '-': "#45;";
        readonly '"': "#34;";
        readonly '\\': "#92;";
        readonly _: "#95;";
        readonly '{': "#123;";
        readonly '}': "#125;";
        readonly '&': "#38;";
        readonly '\'': "#39;";
        readonly ':': "#58;";
        readonly '\u2228': "#8744;";
        readonly '\u2227': "#8743;";
        readonly '\u00AC': "#172;";
        readonly '\u2192': "#8594;";
        readonly '\u2194': "#8596;";
        readonly '\u21D2': "#8658;";
        readonly '\u21D4': "#8660;";
        readonly '\u2200': "#8704;";
        readonly '\u2203': "#8707;";
        readonly '\u2208': "#8712;";
        readonly '\u2209': "#8713;";
        readonly '\u220B': "#8715;";
        readonly '\u220C': "#8716;";
        readonly '\u2229': "#8745;";
        readonly '\u222A': "#8746;";
        readonly '\u222B': "#8747;";
        readonly '\u2295': "#8853;";
    };
    /**
     * Escapes markdown special characters in a string.
     */
    readonly escape: (this: void, text: string) => string;
    /**
     * Escapes a string or number to be used as a mermaid node id.
     */
    readonly escapeId: (this: void, text: string | number) => string;
    /**
     * Converts mermaid code (potentially produced by {@link DataflowMermaid.convert}) to an url that presents the graph in the mermaid editor.
     * @param code - code to convert
     * @param edit - if true, the url will point to the editor, otherwise it will point to the viewer
     */
    readonly codeToUrl: (this: void, code: string, edit?: boolean) => string;
};