TinyBase logoTinyBase β

resolveQueries

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

resolveQueries(queriesOrQueriesId?: MaybeGetter<undefined | QueriesOrQueriesId>): () => Queries | undefined
TypeDescription
queriesOrQueriesId?MaybeGetter<undefined | QueriesOrQueriesId>

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

returns() => Queries | undefined

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

{resolveQueries('petQueries')()?.getResultCell(
  'petSpecies',
  'fido',
  'species',
)}
App.svelte
<svelte:options runes={true} />

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

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

<Provider queriesById={{petQueries: queries}}>
  <Child />
</Provider>

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

const store = createStore().setCell('pets', 'fido', 'species', 'dog');
const queries = createQueries(store).setQueryDefinition(
  'petSpecies',
  'pets',
  ({select}) => select('species'),
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {queries}}));
console.log(app.textContent);
// -> 'dog'

Since

v8.1.0