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

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

Returns

A string value.

Example

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

Source

packages/ts/src/graph/render.ts