TinyBase logoTinyBase β

useMetricListener

The useMetricListener hook registers a listener that is called whenever a specified Metric value changes.

useMetricListener(
  metricId: MaybeGetter<IdOrNull>,
  listener: MetricListener,
  metricsOrMetricsId?: MaybeGetter<undefined | MetricsOrMetricsId>,
): void
TypeDescription
metricIdMaybeGetter<IdOrNull>

The Id of the Metric to listen to, or null to listen to any Metric.

listenerMetricListener

The function to call when the Metric changes.

metricsOrMetricsId?MaybeGetter<undefined | MetricsOrMetricsId>

The Metrics object to use, or its Id.

returnsvoid

This has no return value.

Since

v8.1.0