`useMetricsOrMetricsById`

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

useMetricsOrMetricsById(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.

Since

v8.1.0