`provideMetrics`

The provideMetrics function registers a Metrics object with a given Id into the current Provider context.

provideMetrics(
  metricsId: string,
  metrics: Metrics,
): void

	Type	Description
`metricsId`	`string`	The `Id` to register the `Metrics` object under.
`metrics`	`Metrics`	The `Metrics` object to register.
returns	`void`	This has no return value.

Example

This example registers a TinyBase object dynamically in a Provider context.

Registrar.svelte

<svelte:options runes={true} />

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

  let {metrics} = $props();

  provideMetrics('registered', metrics);
</script>

Reader.svelte

<svelte:options runes={true} />

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

  const ids = getMetricsIds();
</script>

{JSON.stringify(getMetricsIds().current)}

App.svelte

<svelte:options runes={true} />

<script>
  import {Provider} from 'tinybase/ui-svelte';
  import Reader from './Reader.svelte';
  import Registrar from './Registrar.svelte';

  let {metrics} = $props();
</script>

<Provider>
  <Registrar {metrics} />
  <Reader />
</Provider>

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

const store = createStore().setCell('pets', 'fido', 'species', 'dog');
const metrics = createMetrics(store).setMetricDefinition(
  'petCount',
  'pets',
  'count',
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {metrics}}));
flushSync();
console.log(app.textContent);
// -> ' ["registered"]'

Since

v8.1.0