useSelector

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

Defined in: 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#

readonly current: TSelected;

Examples#

const count = useSelector(counterStore, (state) => state.count)
console.log(count.current)

const doubled = useSelector(countAtom, (value) => value * 2)