Store Docs
API Reference
Store API Reference
- Store
- ReadonlyStore
- Atom
- AtomOptions
- BaseAtom
- InternalBaseAtom
- InternalReadonlyAtom
- InteropSubscribable
- Readable
- ReadonlyAtom
- StoreActionsApi
- Subscribable
- Subscription
- AnyAtom
- Observer
- Selection
- StoreAction
- StoreActionMap
- StoreActionsFactory
- batch
- createAsyncAtom
- createAtom
- createStore
- flush
- shallow
- toObserver
- createStoreContext
- useCreateAtom
- useCreateStore
- useSelector
- useSetValue
- useAtom
- useStoreActions
- _useStore (experimental)
- useStore (deprecated)
- UseSelectorOptions
AI/LLM: This documentation page is available in plain markdown format at/store/latest/docs/framework/react/reference/functions/useStore.md
Store API Reference
_useStore
ts
function _useStore<TState, TActions, TSelected>(
store,
selector,
options?): [TSelected, [TActions] extends [never] ? (updater) => void : TActions];Defined in: packages/react-store/src/_useStore.ts:24
Experimental combined read+write hook for stores, mirroring useAtom's tuple pattern.
Returns [selected, actions] when the store has an actions factory, or [selected, setState] for plain stores.
Type Parameters#
TState#
TState
TActions#
TActions extends StoreActionMap
TSelected#
TSelected = NoInfer<TState>
Parameters#
store#
Store<TState, TActions>
selector#
(state) => TSelected
options?#
UseSelectorOptions<TSelected>
Returns#
[TSelected, [TActions] extends [never] ? (updater) => void : TActions]
Example#
tsx
// Store with actions
const [cats, { addCat }] = _useStore(petStore, (s) => s.cats)
// Store without actions
const [count, setState] = _useStore(plainStore, (s) => s)
setState((prev) => prev + 1)