TinyBase logoTinyBase β

useMetric

The useMetric hook returns a reactive object reflecting the value of a named Metric in a Metrics object, and registers a listener so that any changes to that Metric will update .current.

useMetric(
  metricId: MaybeGetter<string>,
  metricsOrMetricsId?: MaybeGetter<undefined | MetricsOrMetricsId>,
): {current: number | undefined}
TypeDescription
metricIdMaybeGetter<string>

The Id of the Metric (or a getter returning it).

metricsOrMetricsId?MaybeGetter<undefined | MetricsOrMetricsId>

The Metrics object to use (plain or getter), or its Id.

returns{current: number | undefined}

A reactive object with a current number | undefined property.

Since

v8.1.0