_useStore

Function: _useStore()

function _useStore<TState, TActions, TSelected>(
   store, 
   selector, 
   options?): [Accessor<TSelected>, [TActions] extends [never] ? (updater) => void : TActions];

function _useStore<TState, TActions, TSelected>(
   store, 
   selector, 
   options?): [Accessor<TSelected>, [TActions] extends [never] ? (updater) => void : TActions];

Defined in: solid-store/src/_useStore.ts:23

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

TActions

TActions extends StoreActionMap

TSelected

TSelected = NoInfer<TState>

Parameters

store

Store<TState, TActions>

selector

(state) => TSelected

options?

UseSelectorOptions<TSelected>

Returns

[Accessor<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)

// 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)