`useSynchronizerOrSynchronizerById`

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

useSynchronizerOrSynchronizerById(synchronizerOrSynchronizerId?: MaybeGetter<undefined | SynchronizerOrSynchronizerId>): () => Synchronizer | undefined

Type Description

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

synchronizerOrSynchronizerId?

MaybeGetter<undefined | SynchronizerOrSynchronizerId>

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

returns

() => Synchronizer | undefined

A getter function returning the Synchronizer object, or undefined.

Since

v8.1.0