TinyBase logoTinyBase β

onSliceIds

The onSliceIds function registers a listener that is called whenever the Slice Ids in an Index change.

onSliceIds(
  indexId: MaybeGetter<IdOrNull>,
  listener: SliceIdsListener,
  indexesOrIndexesId?: MaybeGetter<undefined | IndexesOrIndexesId>,
): void
TypeDescription
indexIdMaybeGetter<IdOrNull>

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

listenerSliceIdsListener

The function to call when Slice Ids change.

indexesOrIndexesId?MaybeGetter<undefined | IndexesOrIndexesId>

The Indexes object to use, or its Id.

returnsvoid

This has no return value.

Example

This example registers a Svelte listener and responds to a TinyBase change.

App.svelte
<svelte:options runes={true} />

<script>
  import {onSliceIds} from 'tinybase/ui-svelte';

  let {indexes} = $props();
  let seen = $state('');

  onSliceIds('bySpecies', () => (seen = 'changed'), indexes);
</script>

{seen}
import {flushSync, mount} from 'svelte';
import {createIndexes, createStore} from 'tinybase';
import App from './App.svelte';

const store = createStore()
  .setTables({
    pets: {
      fido: {species: 'dog', color: 'brown', sold: false, next: 'felix'},
      felix: {species: 'cat', color: 'black', sold: true},
    },
    species: {dog: {price: 5}, cat: {price: 4}},
  })
  .setValues({open: true, employees: 3});
const indexes = createIndexes(store).setIndexDefinition(
  'bySpecies',
  'pets',
  'species',
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {indexes}}));
flushSync(() => {
  store.setCell('pets', 'rex', 'species', 'lizard');
});
flushSync();
console.log(app.textContent);
// -> 'changed'

Since

v8.1.0