`resolveSynchronizer`

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

resolveSynchronizer(synchronizerOrSynchronizerId?: MaybeGetter<undefined | SynchronizerOrSynchronizerId>): () => Synchronizer | undefined

Type Description

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

synchronizerOrSynchronizerId?

MaybeGetter<undefined | SynchronizerOrSynchronizerId>

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

returns

() => Synchronizer | undefined

A getter function returning the Synchronizer 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 {resolveSynchronizer, getSynchronizerIds} from 'tinybase/ui-svelte';
</script>

{resolveSynchronizer('petSynchronizer')()?.getStatus()}

App.svelte

<svelte:options runes={true} />

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

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

<Provider synchronizersById={{petSynchronizer: synchronizer}}>
  <Child />
</Provider>

import {flushSync, mount} from 'svelte';
import {createMergeableStore} from 'tinybase';
import {createLocalSynchronizer} from 'tinybase/synchronizers/synchronizer-local';
import App from './App.svelte';

const synchronizer = createLocalSynchronizer(createMergeableStore());
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {synchronizer}}));
console.log(app.textContent);
// -> '0'

Since

v8.1.0