TinyBase logoTinyBase β

useSynchronizerStatus

The useSynchronizerStatus hook returns a reactive object reflecting the status of a Synchronizer, and registers a listener so that any changes will update .current.

useSynchronizerStatus(synchronizerOrSynchronizerId?: MaybeGetter<undefined | SynchronizerOrSynchronizerId>): {current: Status}
TypeDescription
synchronizerOrSynchronizerId?MaybeGetter<undefined | SynchronizerOrSynchronizerId>

The Synchronizer to use, or its Id.

returns{current: Status}

A reactive object with a current Status property.

Since

v8.1.0