Yantrix

@yantrix/mermaid-parser v0.5.2 • Docs

Yantrix API / @yantrix/mermaid-parser / parseStateDiagram

Function: parseStateDiagram() ​

ts
function parseStateDiagram(diagramText): Promise<TStateDiagramStructure>

The main function that collects all the information from the Mermaid diagram and transforms it into a form appropriate for processing with other parts of the Yantrix toolkit.

Parameters ​

• diagramText: string

Text of the diagram written in accordance with Mermaid syntax.

Returns ​

Promise<TStateDiagramStructure>

Dictionary that contains information from the diagram for further processing, such as:

  • States
  • Actions
  • Notes with Yantrix subsyntax
  • Forks with multiple choices