@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface DescribeOptions

    Options for describeFlows / bot.describe().

    interface DescribeOptions {
        format?: "mermaid" | "json";
        direction?: "TD" | "TB" | "BT" | "LR" | "RL";
        maxLabelLength?: number;
    }
    Index
    format? direction? maxLabelLength?
    format?: "mermaid" | "json"

    'mermaid' (default) returns a Mermaid flowchart string; 'json' returns a FlowGraph.

    direction?: "TD" | "TB" | "BT" | "LR" | "RL"

    Mermaid layout direction (default 'TD', top-down).

    maxLabelLength?: number

    Max characters of each piece of user text (message, prompt, option, trigger) in Mermaid labels; longer text is cut with …. Default 60; Infinity keeps everything. The JSON graph is never truncated.

    Settings
    Member Visibility

    On This Page
    Properties