TinyBase logoTinyBase β

onPersisterStatus

The onPersisterStatus function registers a listener that is called whenever the status of a Persister changes.

onPersisterStatus(
  listener: StatusListener,
  persisterOrPersisterId?: MaybeGetter<undefined | PersisterOrPersisterId>,
): void
TypeDescription
listenerStatusListener

The function to call when the status changes.

persisterOrPersisterId?MaybeGetter<undefined | PersisterOrPersisterId>

The Persister 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 {onPersisterStatus} from 'tinybase/ui-svelte';

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

  onPersisterStatus(() => (seen = 'changed'), persister);
</script>

{seen}
import {flushSync, mount} from 'svelte';
import {createStore} from 'tinybase';
import {createCustomPersister} from 'tinybase/persisters';
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 persister = createCustomPersister(
  store,
  async () => undefined,
  async () => {},
  () => undefined,
  () => {},
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {persister}}));
await persister.save();
flushSync();
console.log(app.textContent);
// -> 'changed'

Since

v8.1.0