TinyBase logoTinyBase β

resolveIndexes

The resolveIndexes function is used to get a reference to an Indexes object from a Provider context, or have it passed directly.

resolveIndexes(indexesOrIndexesId?: MaybeGetter<undefined | IndexesOrIndexesId>): () => Indexes | undefined
TypeDescription
indexesOrIndexesId?MaybeGetter<undefined | IndexesOrIndexesId>

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

returns() => Indexes | undefined

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

{resolveIndexes('petIndexes')()
  ?.getSliceRowIds('bySpecies', 'dog')
  ?.join(',')}
App.svelte
<svelte:options runes={true} />

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

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

<Provider indexesById={{petIndexes: indexes}}>
  <Child />
</Provider>

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

const store = createStore().setCell('pets', 'fido', 'species', 'dog');
const indexes = createIndexes(store).setIndexDefinition(
  'bySpecies',
  'pets',
  'species',
);
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {indexes}}));
console.log(app.textContent);
// -> 'fido'

Since

v8.1.0