GraphReFlyTS

API Reference

describeToAscii()

Render a D39 describe snapshot as a compact ASCII adjacency diagram.

Import

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

Signature

function describeToAscii(
	snapshot: DescribeSnapshot,
	opts: DescribeToAsciiOptions = {},
): string

Parameters

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

Returns

A string value.

Example

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

Source

packages/ts/src/graph/render.ts