GraphReFlyTS

API Reference

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

ParameterTypeDescription
snapshotDescribeSnapshotsnapshot value used by the helper.
optsDescribeToMermaidOptionsOptions that configure the helper.

Returns

A string value.

Example

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

Source

packages/ts/src/graph/render.ts