TinyBase logoTinyBase

delListener

The delListener method removes a listener that was previously added to the Queries object.

delListener(listenerId: string): Queries
TypeDescription
listenerIdstring

The Id of the listener to remove.

returnsQueries

A reference to the Queries object.

Use the Id returned by the addMetricListener method. Note that the Queries object may re-use this Id for future listeners added to it.

Example

This example creates a Store, a Queries object, registers a listener, and then removes it.

import {createQueries, createStore} from 'tinybase';

const store = createStore().setTable('pets', {
  fido: {species: 'dog'},
  felix: {species: 'cat'},
  cujo: {species: 'dog'},
});

const queries = createQueries(store).setQueryDefinition(
  'species',
  'pets',
  ({select}) => {
    select('species');
  },
);

const listenerId = queries.addResultTableListener('species', () =>
  console.log('species result changed'),
);

store.setCell('pets', 'ed', 'species', 'horse');
// -> 'species result changed'

queries.delListener(listenerId);

store.setCell('pets', 'molly', 'species', 'cow');
// -> undefined
// The listener is not called.

Since

v2.0.0