TinyBase logoTinyBase β

getTables

The getTables function returns a reactive object reflecting the Tables in the Store, and registers a listener so that any changes to those Tables will update current.

getTables(storeOrStoreId?: MaybeGetter<undefined | StoreOrStoreId>): {current: Tables}
TypeDescription
storeOrStoreId?MaybeGetter<undefined | StoreOrStoreId>

The Store to use, or its Id in a Provider context.

returns{current: Tables}

A reactive object with a current Tables property.

Example

This example passes a TinyBase object into a Svelte component and reads the reactive object's current property.

App.svelte
<svelte:options runes={true} />

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

  let {store} = $props();

  const result = getTables(store);
</script>

{JSON.stringify(result.current)}

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

const store = createStore()
  .setTables({
    pets: {
      fido: {species: 'dog', color: 'brown', sold: false, next: 'felix'},
      felix: {species: 'cat', color: 'black', sold: true},
    },
    species: {dog: {price: 5}, cat: {price: 4}},
  })
  .setValues({open: true, employees: 3});
const app = document.body.appendChild(document.createElement('div'));
flushSync(() => mount(App, {target: app, props: {store}}));
console.log(app.textContent);
// ->
`
{
  "pets":{
    "fido":{
      "species":"dog",
      "color":"brown",
      "sold":false,
      "next":"felix"
    },
    "felix":{
      "species":"cat",
      "color":"black",
      "sold":true
    }
  },
  "species":{
    "dog":{
      "price":5
    },
    "cat":{
      "price":4
    }
  }
}
`;

Since

v8.1.0