`resolvePersister`

The resolvePersister function is used to get a reference to a Persister object from a Provider context, or have it passed directly.

resolvePersister(persisterOrPersisterId?: MaybeGetter<undefined | PersisterOrPersisterId>): () => AnyPersister | undefined

Type Description

	Type	Description
`persisterOrPersisterId?`	`MaybeGetter<undefined \| PersisterOrPersisterId>`	The `Persister` object, its `Id`, or a getter returning either.
returns	`() => AnyPersister \| undefined`	A getter function returning the `Persister` object, or `undefined`.

persisterOrPersisterId?

MaybeGetter<undefined | PersisterOrPersisterId>

The Persister object, its Id, or a getter returning either.

returns

() => AnyPersister | undefined

A getter function returning the Persister object, or undefined.

Example

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

Child.svelte

<svelte:options runes={true} />

<script>
  import {resolvePersister, getPersisterIds} from 'tinybase/ui-svelte';
</script>

{resolvePersister('petPersister')()?.getStatus()}

App.svelte

<svelte:options runes={true} />

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

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

<Provider persistersById={{petPersister: 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