`onMetric`

The onMetric function registers a listener that is called whenever a specified Metric value changes.

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

	Type	Description
`metricId`	`MaybeGetter<IdOrNull>`	The `Id` of the `Metric` to listen to, or `null` to listen to any `Metric`.
`listener`	`MetricListener`	The function to call when the `Metric` changes.
`metricsOrMetricsId?`	`MaybeGetter<undefined \| MetricsOrMetricsId>`	The `Metrics` object to use, or its `Id`.
returns	`void`	This has no return value.

Example

This example registers a Svelte listener and responds to a TinyBase change.

App.svelte

<svelte:options runes={true} />

<script>
  import {onMetric} from 'tinybase/ui-svelte';

  let {metrics} = $props();
  let seen = $state('');

  onMetric('petCount', () => (seen = 'changed'), metrics);
</script>

{seen}

import {flushSync, mount} from 'svelte';
import {createMetrics, createStore} from 'tinybase';
import App from './App.svelte';

const store = createStore()
  .setTables({
    pets: {
      fido: {species: 'dog', color: 'brown', sold: false, next: 'felix'},
      felix: {species: 'cat', color: 'black', sold: true},
    },
    species: {dog: {price: 5}, cat: {price: 4}},
  })
  .setValues({open: true, employees: 3});
const metrics = createMetrics(store).setMetricDefinition(
  'petCount',
  'pets',
  'count',
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {metrics}}));
flushSync(() => {
  store.setRow('pets', 'cujo', {species: 'dog'});
});
flushSync();
console.log(app.textContent);
// -> 'changed'

Since

v8.1.0