generateDiagram

function generateDiagram(params):
  | SvgOutput
  | HtmlOutput
  | MermaidOutput;

Defined in: src/index.ts:217

Generate a diagram from an ASL definition (auto-detects format from options)

This is a convenience function that generates either an SVG or Mermaid diagram based on the format option. If no format is specified, defaults to SVG.

Parameters

params

GenerateDiagramParams

Configuration object

Returns

| SvgOutput | HtmlOutput | MermaidOutput

SVG output if format is ‘svg’, Mermaid output if format is ‘mermaid’, interactive HTML output if format is ‘html’

Throws

If params.aslDefinition is a string with invalid JSON (also an instanceof SyntaxError and AslValidationError)

Throws

If the ASL definition structure is invalid

Example

import { generateDiagram } from 'sfn-diagram';

// Generate SVG (default)
const svgResult = generateDiagram({ aslDefinition: myAsl });

// Generate Mermaid
const mermaidResult = generateDiagram({ aslDefinition: myAsl, format: 'mermaid' });