TinyBase logoTinyBase β

useParamValueListener

The useParamValueListener hook registers a listener that is called whenever a specific parameter value for a query changes.

useParamValueListener(
  queryId: MaybeGetter<IdOrNull>,
  paramId: MaybeGetter<IdOrNull>,
  listener: ParamValueListener,
  queriesOrQueriesId?: MaybeGetter<undefined | QueriesOrQueriesId>,
): void
TypeDescription
queryIdMaybeGetter<IdOrNull>

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

paramIdMaybeGetter<IdOrNull>

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

listenerParamValueListener

The function to call when the parameter value changes.

queriesOrQueriesId?MaybeGetter<undefined | QueriesOrQueriesId>

The Queries object to use, or its Id.

returnsvoid

This has no return value.

Since

v8.1.0