`useSynchronizerStatusListener`

The useSynchronizerStatusListener primitive registers a listener function with the Synchronizer that will be called when its status changes.

useSynchronizerStatusListener(
  listener: StatusListener,
  synchronizerOrSynchronizerId?: MaybeAccessor<undefined | SynchronizerOrSynchronizerId>,
): void

	Type	Description
`listener`	`StatusListener`	The function that will be called whenever the status of the `Synchronizer` changes.
`synchronizerOrSynchronizerId?`	`MaybeAccessor<undefined \| SynchronizerOrSynchronizerId>`	The `Synchronizer` to be accessed: omit for the default context `Synchronizer`, provide an `Id` for a named context `Synchronizer`, or provide an explicit reference.
returns	`void`	This has no return value.

This primitive is useful for situations where a component needs to register its own specific listener to do more than simply tracking the value (which is more easily done with the useSynchronizerStatus primitive).

Unlike the addStatusListener method, which returns a listener Id and requires you to remove it manually, the useSynchronizerStatusListener primitive manages this lifecycle for you: when the component unmounts, the listener on the underlying Synchronizer will be deleted.

Example

This example creates the TinyBase objects needed by the Solid primitive or component and calls it from within a reactive root.

import {createRoot} from 'solid-js';
import {
  createCheckpoints,
  createIndexes,
  createMetrics,
  createQueries,
  createRelationships,
  createStore,
} from 'tinybase';
import {useSynchronizerStatusListener} from 'tinybase/ui-solid';

createRoot((dispose) => {
  const store = createStore()
    .setTables({
      pets: {
        fido: {species: 'dog', color: 'brown', next: 'felix'},
        felix: {species: 'cat', color: 'black'},
      },
      species: {dog: {price: 5}, cat: {price: 4}},
    })
    .setValues({open: true});
  const metrics = createMetrics(store).setMetricDefinition(
    'highestPrice',
    'species',
    'max',
    'price',
  );
  const indexes = createIndexes(store).setIndexDefinition(
    'bySpecies',
    'pets',
    'species',
  );
  const relationships = createRelationships(store)
    .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    .setRelationshipDefinition('nextPet', 'pets', 'pets', 'next');
  const queries = createQueries(store).setQueryDefinition(
    'petColors',
    'pets',
    ({select, where, param}) => {
      select('color');
      where((getCell) => getCell('species') == param('species'));
    },
    {species: 'dog'},
  );
  const checkpoints = createCheckpoints(store);
  store.setCell('pets', 'fido', 'color', 'walnut');
  checkpoints.setCheckpoint('updated color');
  metrics.getMetric('highestPrice');
  indexes.getSliceIds('bySpecies');
  relationships.getRemoteRowId('petSpecies', 'fido');
  queries.getResultRowIds('petColors');
  useSynchronizerStatusListener(() => undefined);
  dispose();
});

Since

v8.3.0