`provideIndexes`

The provideIndexes function registers an Indexes object with a given Id into the current Provider context.

provideIndexes(
  indexesId: string,
  indexes: Indexes,
): void

	Type	Description
`indexesId`	`string`	The `Id` to register the `Indexes` object under.
`indexes`	`Indexes`	The `Indexes` 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 {provideIndexes} from 'tinybase/ui-svelte';

  let {indexes} = $props();

  provideIndexes('registered', indexes);
</script>

Reader.svelte

<svelte:options runes={true} />

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

  const ids = getIndexesIds();
</script>

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

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

Since

v8.1.0