Source: https://tanstack.com/store/latest/docs/framework/svelte/reference/functions/usestore

TanStack

Store v0v0

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

Svelte

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Installation
  
  core

• Quick Start
  
  core

• Quick Start
  
  svelte

API Reference

• JavaScript Reference
  
  core

• Classes / Store
  
  core

• Classes / Derived
  
  core

• Classes / Effect
  
  core

• Interfaces / StoreOptions
  
  core

• Interfaces / DerivedOptions
  
  core

• Svelte Reference
  
  svelte

• Functions / useStore
  
  svelte

• Functions / shallow
  
  svelte

Examples

• Simple
  
  svelte

Framework

Svelte

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Installation
  
  core

• Quick Start
  
  core

• Quick Start
  
  svelte

API Reference

• JavaScript Reference
  
  core

• Classes / Store
  
  core

• Classes / Derived
  
  core

• Classes / Effect
  
  core

• Interfaces / StoreOptions
  
  core

• Interfaces / DerivedOptions
  
  core

• Svelte Reference
  
  svelte

• Functions / useStore
  
  svelte

• Functions / shallow
  
  svelte

Examples

• Simple
  
  svelte

On this page

• Function: useStore()

• Call Signature

• Type Parameters

• Parameters

• store

• selector?

• options?

• Returns

• current

• Call Signature

• Type Parameters

• Parameters

• store

• selector?

• options?

• Returns

• current

useStore

Copy Markdown

Function: useStore()
==================== Call Signature
--------------

ts

function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): object


function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): object

Defined in: index.svelte.ts:14

### Type Parameters

• TState

• TSelected = NoInfer<TState>

### Parameters #### store

Store<TState, any>

#### selector?

(state) => TSelected

#### options?

UseStoreOptions<TSelected>

### Returns

object

#### current

ts

readonly current: TSelected;


readonly current: TSelected;

Call Signature
--------------

ts

function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): object


function useStore<TState, TSelected>(
   store, 
   selector?, 
   options?): object

Defined in: index.svelte.ts:19

### Type Parameters

• TState

• TSelected = NoInfer<TState>

### Parameters #### store

Derived<TState, any>

#### selector?

(state) => TSelected

#### options?

UseStoreOptions<TSelected>

### Returns

object

#### current

ts

readonly current: TSelected;


readonly current: TSelected;

Edit on GitHub

Svelte Reference

Functions / shallow

Partners Become a Partner