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
- 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/svelte/reference/functions/useStore-1.md
Store API Reference
useStore
ts
function useStore<TState, TSelected>(
source,
selector?,
compare?): object;Defined in: useStore.ts:15
Deprecated alias for useSelector.
Type Parameters#
TState#
TState
TSelected#
TSelected = NoInfer<TState>
Parameters#
source#
| Atom<TState> | ReadonlyAtom<TState> | Store<TState, any> | ReadonlyStore<TState>
selector?#
(state) => TSelected
compare?#
(a, b) => boolean
Returns#
object
current#
ts
readonly current: TSelected;Example#
ts
const count = useStore(counterStore, (state) => state.count)
console.log(count.current)Deprecated#
Use useSelector instead.