`useMetrics`

The useMetrics hook returns the default Metrics object from the current Provider context (or a named one if an Id is provided).

useMetrics(id?: string): Metrics | undefined

Type Description

	Type	Description
`id?`	`string`	An optional `Id` of a named `Metrics` object in the Provider context.
returns	`Metrics \| undefined`	The `Metrics` object, or `undefined` if not found.

id?

string

An optional Id of a named Metrics object in the Provider context.

returns

Metrics | undefined

The Metrics object, or undefined if not found.

Since

v8.1.0