GraphReFlyTS

API Reference

describeToMermaidUrl()

Render a D39 describe snapshot as a mermaid.live deep link.

Import

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

Signature

function describeToMermaidUrl(
	snapshot: DescribeSnapshot,
	opts: DescribeToMermaidUrlOptions = {},
): string

Parameters

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

Returns

A string value.

Example

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

Source

packages/ts/src/graph/render.ts