TinyBase logoTinyBase β

getPersisterStatus

The getPersisterStatus function returns a reactive object reflecting the status of a Persister, and registers a listener so that any changes will update current.

getPersisterStatus(persisterOrPersisterId?: MaybeGetter<undefined | PersisterOrPersisterId>): {current: Status}
TypeDescription
persisterOrPersisterId?MaybeGetter<undefined | PersisterOrPersisterId>

The Persister to use, or its Id.

returns{current: Status}

A reactive object with a current Status property.

Example

This example reads a TinyBase object from Svelte context inside a child component.

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

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

{getPersisterStatus().current}
App.svelte
<svelte:options runes={true} />

<script>
  import {Provider} from 'tinybase/ui-svelte';
  import Child from './Child.svelte';

  let {persister} = $props();
</script>

<Provider {persister}>
  <Child />
</Provider>

import {flushSync, mount} from 'svelte';
import {createStore} from 'tinybase';
import {createCustomPersister} from 'tinybase/persisters';
import App from './App.svelte';

const store = createStore().setCell('pets', 'fido', 'species', 'dog');
const persister = createCustomPersister(
  store,
  async () => undefined,
  async () => {},
  () => undefined,
  () => {},
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {persister}}));
console.log(app.textContent);
// -> '0'

Since

v8.1.0