measurementOk()

Create a successful measurement fact.

Import

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

Signature

function measurementOk(
  targetId: string,
  measurementKind: string,
  value: T,
  opts: { readonly source?: string; readonly metadata?: Record<string, unknown> } = {},
): MeasurementResult<T>

Parameters

Parameter	Type	Description
targetId	string	Measurement target id.
measurementKind	string	Measurement kind tag.
value	T	Measured value.
opts	{ readonly source?: string; readonly metadata?: Record<string, unknown> }	Optional source and metadata.

Returns

A successful measurement fact.

Example

measurementOk("title", "text-segments", { segments: [] });

Source

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