TinyBase logoTinyBase β

getValue

The getValue function returns a reactive object reflecting the value of a Value in a Store, and registers a listener so that any changes to that Value will update current.

getValue(
  valueId: MaybeGetter<string>,
  storeOrStoreId?: MaybeGetter<undefined | StoreOrStoreId>,
): {current: ValueOrUndefined}
TypeDescription
valueIdMaybeGetter<string>

The Id of the Value (or a getter returning it).

storeOrStoreId?MaybeGetter<undefined | StoreOrStoreId>

The Store to use (plain value or getter), or its Id.

returns{current: ValueOrUndefined}

A reactive object with gettable and settable current.

Since Values are mutable leaf values in a Store, the returned object's current property can also be assigned to write back to the Store.

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 {getValue} from 'tinybase/ui-svelte';

  let {store} = $props();

  const result = getValue('open', store);
</script>

{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);
// -> 'true'

Since

v8.1.0