measurementIssue()

Create a measurement issue fact.

Import

import { measurementIssue } from "@graphrefly/ts/solutions/reactive-layout";

Signature

function measurementIssue(
  code: string,
  message: string,
  targetId: string,
  measurementKind: string,
  opts: {
    readonly source?: string;
    readonly details?: unknown;
    readonly metadata?: Record<string, unknown>;
    readonly severity?: DataIssue["severity"];
  } = {},
): MeasurementIssue

Parameters

Parameter	Type	Description
code	string	Stable issue code.
message	string	Human-readable issue message.
targetId	string	Measurement target id.
measurementKind	string	Measurement kind tag.
opts	{ readonly source?: string; readonly details?: unknown; readonly metadata?: Record<string, unknown>; readonly severity?: DataIssue["severity"]; }	Optional source, severity, details, and metadata.

Returns

A measurement issue fact.

Example

measurementIssue("measurement.failed", "Text measurement failed", "title", "text-segments");

Source

packages/ts/src/solutions/reactive-layout/measurements.ts