Function: useCreateStore()#

Readonly store#

function useCreateStore<T>(getValue): ReadonlyStore<T>;

Defined in: octane-store/src/useCreateStore.ts:25

Creates a stable store instance for the lifetime of the component.

Pass an initial value to create a writable store, or a getter function to create a readonly derived store. This hook mirrors the overloads from createStore, but ensures the store is only created once per mount.

Type Parameters#

T#

T

Parameters#

getValue#

(prev?) => T

Returns#

ReadonlyStore<T>

Example#

const counterStore = useCreateStore({ count: 0 })

Writable store#

function useCreateStore<T>(initialValue): Store<T>;

Defined in: octane-store/src/useCreateStore.ts:28

Creates a stable store instance for the lifetime of the component.

Pass an initial value to create a writable store, or a getter function to create a readonly derived store. This hook mirrors the overloads from createStore, but ensures the store is only created once per mount.

Type Parameters#

T#

T

Parameters#

initialValue#

T

Returns#

Store<T>

Example#

const counterStore = useCreateStore({ count: 0 })

Store with actions#

function useCreateStore<T, TActions>(initialValue, actions): Store<T, TActions>;

Defined in: octane-store/src/useCreateStore.ts:29

Creates a stable store instance for the lifetime of the component.

Pass an initial value to create a writable store, or a getter function to create a readonly derived store. This hook mirrors the overloads from createStore, but ensures the store is only created once per mount.

Type Parameters#

T#

T

TActions#

TActions extends StoreActionMap

Parameters#

initialValue#

NonFunction<T>

actions#

StoreActionsFactory<T, TActions>

Returns#

Store<T, TActions>

Example#

const counterStore = useCreateStore({ count: 0 })