useSelector

Function: useSelector()

ts
function useSelector<TState, TSelected>(
   source, 
   selector, 
   options): object;
function useSelector<TState, TSelected>(
   source, 
   selector, 
   options): object;

Defined in: svelte-store/src/useSelector.svelte.ts:28

Selects a slice of state from an atom or store and exposes it through a rune-friendly holder object.

Read the selected value from .current.

Type Parameters

TState

TState

TSelected

TSelected = NoInfer<TState>

Parameters

source

Atom<TState> | ReadonlyAtom<TState> | Store<TState, any> | ReadonlyStore<TState>

selector

(state) => TSelected

options

UseSelectorOptions<TSelected> = {}

Returns

object

current

ts
readonly current: TSelected;
readonly current: TSelected;

Examples

ts
const count = useSelector(counterStore, (state) => state.count)
console.log(count.current)
const count = useSelector(counterStore, (state) => state.count)
console.log(count.current)
ts
const doubled = useSelector(countAtom, (value) => value * 2)
const doubled = useSelector(countAtom, (value) => value * 2)
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.