describeToMermaid()

Render a D39 describe snapshot as Mermaid flowchart text.

Import

import { describeToMermaid } from "@graphrefly/ts/graph";

Signature

function describeToMermaid(
  snapshot: DescribeSnapshot,
  opts: DescribeToMermaidOptions = {},
): string

Parameters

Parameter	Type	Description
snapshot	DescribeSnapshot	snapshot value used by the helper.
opts	DescribeToMermaidOptions	Options that configure the helper.

Returns

A string value.

Example

import { describeToMermaid } from "@graphrefly/ts/graph";

Source

packages/ts/src/graph/render.ts