`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}

Type Description

	Type	Description
`valueId`	`MaybeGetter<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`.

valueId

MaybeGetter<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.

Since

v8.1.0