openmrs-esm-core

O3 Framework / createUseStore

Function: createUseStore()

createUseStore<T>(store): {(): T; <A>(actions): T & BoundActions<T, A>; <A>(actions?): T & BoundActions<T, A>; }

Defined in: packages/framework/esm-react-utils/src/useStore.ts:104

Whenever possible, use useStore(yourStore) instead. This function is for creating a custom hook for a specific store.

Type Parameters

T

T

Parameters

store

StoreApi<T>

Returns

(): T

Returns

T

<A>(actions): T & BoundActions<T, A>

Type Parameters

A

A extends Actions<T>

Parameters

actions

A

Returns

T & BoundActions<T, A>

<A>(actions?): T & BoundActions<T, A>

Type Parameters

A

A extends Actions<T>

Parameters

actions?

A

Returns

T & BoundActions<T, A>