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

    Function describeFlows

    • Describe every registered flow/conversation of a bot (or a plain list of flows) as a Mermaid flowchart (default) or a JSON graph.

      • One Mermaid subgraph per DSL flow; its entry node lists the triggers routed to it (bot.use, bot.when(trigger, flow), …).
      • choose options are labelled 1) Label like the menu the user sees; a then sub-flow is drawn as a nested subgraph that returns to the parent.
      • goto is a dotted edge to the target; an unregistered target is drawn as a missing: name node.
      • Async conversations are a single node (their body is opaque).
      • User text is escaped with Mermaid entity codes, so labels can never break out of their node or inject %%{init}%% directives.

      Node ids are stable and shared by both formats and by lintFlows() diagnostics.

      Parameters

      Returns FlowGraph

    • Describe every registered flow/conversation of a bot (or a plain list of flows) as a Mermaid flowchart (default) or a JSON graph.

      • One Mermaid subgraph per DSL flow; its entry node lists the triggers routed to it (bot.use, bot.when(trigger, flow), …).
      • choose options are labelled 1) Label like the menu the user sees; a then sub-flow is drawn as a nested subgraph that returns to the parent.
      • goto is a dotted edge to the target; an unregistered target is drawn as a missing: name node.
      • Async conversations are a single node (their body is opaque).
      • User text is escaped with Mermaid entity codes, so labels can never break out of their node or inject %%{init}%% directives.

      Node ids are stable and shared by both formats and by lintFlows() diagnostics.

      Parameters

      Returns string

    • Describe every registered flow/conversation of a bot (or a plain list of flows) as a Mermaid flowchart (default) or a JSON graph.

      • One Mermaid subgraph per DSL flow; its entry node lists the triggers routed to it (bot.use, bot.when(trigger, flow), …).
      • choose options are labelled 1) Label like the menu the user sees; a then sub-flow is drawn as a nested subgraph that returns to the parent.
      • goto is a dotted edge to the target; an unregistered target is drawn as a missing: name node.
      • Async conversations are a single node (their body is opaque).
      • User text is escaped with Mermaid entity codes, so labels can never break out of their node or inject %%{init}%% directives.

      Node ids are stable and shared by both formats and by lintFlows() diagnostics.

      Parameters

      Returns string | FlowGraph