`useCheckpoints`

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

useCheckpoints(id?: string): Checkpoints | undefined

Type Description

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

id?

string

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

returns

Checkpoints | undefined

The Checkpoints object, or undefined if not found.

Since

v8.1.0