TinyBase logoTinyBase β

getRelationships

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

getRelationships(id?: string): Relationships | undefined
TypeDescription
id?string

An optional Id of a named Relationships object in the Provider context.

returnsRelationships | undefined

The Relationships object, 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 {getRelationships} from 'tinybase/ui-svelte';
</script>

{getRelationships()?.getRemoteRowId('petSpecies', 'fido')}
App.svelte
<svelte:options runes={true} />

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

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

<Provider {relationships}>
  <Child />
</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}}));
console.log(app.textContent);
// -> 'dog'

Since

v8.1.0