`getPersister`

The getPersister function returns the default Persister from the current Provider context (or a named one if an Id is provided).

getPersister(id?: string): AnyPersister | undefined

Type Description

	Type	Description
`id?`	`string`	An optional `Id` of a named `Persister` in the Provider context.
returns	`AnyPersister \| undefined`	The `Persister`, or `undefined` if not found.

id?

string

An optional Id of a named Persister in the Provider context.

returns

AnyPersister | undefined

The Persister, or undefined if not found.

Example

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

Child.svelte

<svelte:options runes={true} />

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

{getPersister()?.getStatus()}

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