`resolveMetrics`

The resolveMetrics function is used to get a reference to a Metrics object from a Provider context, or have it passed directly.

resolveMetrics(metricsOrMetricsId?: MaybeGetter<undefined | MetricsOrMetricsId>): () => Metrics | undefined

Type Description

	Type	Description
`metricsOrMetricsId?`	`MaybeGetter<undefined \| MetricsOrMetricsId>`	The `Metrics` object, its `Id`, or a getter returning either.
returns	`() => Metrics \| undefined`	A getter function returning the `Metrics` object, or `undefined`.

metricsOrMetricsId?

MaybeGetter<undefined | MetricsOrMetricsId>

The Metrics object, its Id, or a getter returning either.

returns

() => Metrics | undefined

A getter function returning the Metrics object, or undefined.

Example

This example reads a TinyBase object from Svelte context inside a child component.

Child.svelte

<svelte:options runes={true} />

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

{resolveMetrics('petMetrics')()?.getMetric('petCount')}

App.svelte

<svelte:options runes={true} />

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

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

<Provider metricsById={{petMetrics: metrics}}>
  <Child />
</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}}));
console.log(app.textContent);
// -> '1'

Since

v8.1.0