`provideRelationships`

The provideRelationships function registers a Relationships object with a given Id into the current Provider context.

provideRelationships(
  relationshipsId: string,
  relationships: Relationships,
): void

	Type	Description
`relationshipsId`	`string`	The `Id` to register the `Relationships` object under.
`relationships`	`Relationships`	The `Relationships` object to register.
returns	`void`	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 {provideRelationships} from 'tinybase/ui-svelte';

  let {relationships} = $props();

  provideRelationships('registered', relationships);
</script>

Reader.svelte

<svelte:options runes={true} />

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

  const ids = getRelationshipsIds();
</script>

{JSON.stringify(getRelationshipsIds().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 {relationships} = $props();
</script>

<Provider>
  <Registrar {relationships} />
  <Reader />
</Provider>

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

const store = createStore().setCell('pets', 'fido', 'species', 'dog');
const relationships = createRelationships(store).setRelationshipDefinition(
  'petSpecies',
  'pets',
  'pets',
  'species',
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {relationships}}));
flushSync();
console.log(app.textContent);
// -> ' ["registered"]'

Since

v8.1.0