Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

useSelector.md

66 lines1.2 KB

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

Defined in: node_modules/.pnpm/@tanstack+svelte-store@0.12.1_svelte@5.56.8_@typescript-eslint+types@8.66.0_/node_modules/@tanstack/svelte-store/dist/useSelector.svelte.d.ts:22

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)