TinyBase logoTinyBase β

useMetricIds

The useMetricIds hook returns a reactive object reflecting the Ids of the Metrics in a Metrics object, and registers a listener so that any changes will update .current.

useMetricIds(metricsOrMetricsId?: MaybeGetter<undefined | MetricsOrMetricsId>): {current: Ids}
TypeDescription
metricsOrMetricsId?MaybeGetter<undefined | MetricsOrMetricsId>

The Metrics object to use, or its Id.

returns{current: Ids}

A reactive object with a current Ids property.

Since

v8.1.0