TinyBase logoTinyBase β

provideSynchronizer

The provideSynchronizer function registers a Synchronizer with a given Id into the current Provider context.

provideSynchronizer(
  synchronizerId: string,
  synchronizer: Synchronizer,
): void
TypeDescription
synchronizerIdstring

The Id to register the Synchronizer under.

synchronizerSynchronizer

The Synchronizer to register.

returnsvoid

This has no return value.

Example

This example registers a TinyBase object dynamically in a Provider context.

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

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

  let {synchronizer} = $props();

  provideSynchronizer('registered', synchronizer);
</script>
Reader.svelte
<svelte:options runes={true} />

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

  const ids = getSynchronizerIds();
</script>

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

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

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

<Provider>
  <Registrar {synchronizer} />
  <Reader />
</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}}));
flushSync();
console.log(app.textContent);
// -> ' ["registered"]'

Since

v8.1.0