TinyBase logoTinyBase β

useValueListener

The useValueListener hook registers a listener that is called whenever the value of a specified Value changes.

useValueListener(
  valueId: MaybeGetter<IdOrNull>,
  listener: ValueListener,
  mutator?: boolean,
  storeOrStoreId?: MaybeGetter<undefined | StoreOrStoreId>,
): void
TypeDescription
valueIdMaybeGetter<IdOrNull>

The Id of the Value to listen to, or null to listen to any Value.

listenerValueListener

The function to call when the Value changes.

mutator?boolean

An optional boolean indicating the listener mutates Store data.

storeOrStoreId?MaybeGetter<undefined | StoreOrStoreId>

The Store to use, or its Id.

returnsvoid

This has no return value.

Since

v8.1.0