GraphReFlyTS

API Reference

profileSummary()

Summarize an opt-in Graph.profile() snapshot while keeping describe() as the source of node cardinality. No counters are stored on nodes (R-profile).

Import

import { profileSummary } from "@graphrefly/ts/patterns";

Signature

function profileSummary(
	graph: Graph,
	opts: { limit?: number } = {},
): ProfileSummary

Parameters

ParameterTypeDescription
graphGraphGraph that owns the created nodes or projector.
opts{ limit?: number }Options that configure the helper.

Returns

A ProfileSummary value.

Example

import { profileSummary } from "@graphrefly/ts/patterns";

Source

packages/ts/src/patterns/inspection.ts