TanStack
Store v0v0
Log In
StartRC
HomeDocsGitHub
Router
HomeDocsGitHub
Query
HomeDocsGitHub
Table
HomeDocsGitHub
DBbeta
HomeDocsGitHub
AIalpha
HomeDocsGitHub
Formnew
HomeDocsGitHub
Virtual
HomeDocsGitHub
Pacerbeta
HomeDocsGitHub
Storealpha
HomeDocsGitHub
Devtoolsalpha
HomeDocsGitHub
More Libraries
More Libraries
FeedBeta
FeedBeta
Maintainers
Maintainers
Partners
Partners
Showcase
Showcase
Blog
Blog
LearnNEW
LearnNEW
Support
Support
Stats
Stats
Discord
Discord
Merch
Merch
GitHub
GitHub
Ethos
Ethos
Tenets
Tenets
Brand Guide
Brand Guide
Docs
CodeRabbitCodeRabbit
CloudflareCloudflare
AG GridAG Grid
NetlifyNetlify
NeonNeon
WorkOSWorkOS
ClerkClerk
ConvexConvex
ElectricElectric
PowerSyncPowerSync
SentrySentry
PrismaPrisma
StrapiStrapi
UnkeyUnkey
UI.dev
CodeRabbitCodeRabbit
CloudflareCloudflare
AG GridAG Grid
NetlifyNetlify
NeonNeon
WorkOSWorkOS
ClerkClerk
ConvexConvex
ElectricElectric
PowerSyncPowerSync
SentrySentry
PrismaPrisma
StrapiStrapi
UnkeyUnkey
UI.dev
Menu
  • Home
  • Frameworks
  • Contributors
  • GitHub
  • Discord
Getting Started
  • Overview
  • Installation
  • Quick Start
  • Quick Start
API Reference
  • JavaScript Reference
  • Classes / Store
  • Interfaces / Atom
  • Interfaces / AtomOptions
  • Interfaces / BaseAtom
  • Interfaces / InternalBaseAtom
  • Interfaces / InternalReadonlyAtom
  • Interfaces / InteropSubscribable
  • Interfaces / Readable
  • Interfaces / ReadonlyAtom
  • Interfaces / Subscribable
  • Interfaces / Subscription
  • Type Aliases / AnyAtom
  • Type Aliases / Observer
  • Type Aliases / Selection
  • Functions / batch
  • Functions / createAsyncAtom
  • Functions / createAtom
  • Functions / createStore
  • Functions / flush
  • Functions / toObserver
  • React Reference
  • Functions / useStore
  • Functions / shallow
Examples
  • Simple
Menu
  • Home
  • Frameworks
  • Contributors
  • GitHub
  • Discord
Getting Started
  • Overview
  • Installation
  • Quick Start
  • Quick Start
API Reference
  • JavaScript Reference
  • Classes / Store
  • Interfaces / Atom
  • Interfaces / AtomOptions
  • Interfaces / BaseAtom
  • Interfaces / InternalBaseAtom
  • Interfaces / InternalReadonlyAtom
  • Interfaces / InteropSubscribable
  • Interfaces / Readable
  • Interfaces / ReadonlyAtom
  • Interfaces / Subscribable
  • Interfaces / Subscription
  • Type Aliases / AnyAtom
  • Type Aliases / Observer
  • Type Aliases / Selection
  • Functions / batch
  • Functions / createAsyncAtom
  • Functions / createAtom
  • Functions / createStore
  • Functions / flush
  • Functions / toObserver
  • React Reference
  • Functions / useStore
  • Functions / shallow
Examples
  • Simple
Learn about TanStack AdsHide Ads
API Reference

Store

Class: Store<T>

Defined in: store.ts:4

Type Parameters

T

T

Constructors

Constructor

ts
new Store<T>(getValue): Store<T>;

Defined in: store.ts:6

Parameters

getValue

(prev?) => T

Returns

Store<T>

Constructor

ts
new Store<T>(initialValue): Store<T>;

Defined in: store.ts:7

Parameters

initialValue

T

Returns

Store<T>

Accessors

state

Get Signature

ts
get state(): T;

Defined in: store.ts:18

Returns

T

Methods

get()

ts
get(): T;

Defined in: store.ts:21

Returns

T


setState()

ts
setState(updater): void;

Defined in: store.ts:15

Parameters

updater

(prev) => T

Returns

void


subscribe()

ts
subscribe(observerOrFn): Subscription;

Defined in: store.ts:24

Parameters

observerOrFn

Observer<T> | (value) => void

Returns

Subscription

Edit on GitHub
PreviousJavaScript Reference
NextInterfaces / Atom

On this page

  • Class: Store
  • Type Parameters
  • T
  • Constructors
  • Constructor
  • Parameters
  • getValue
  • Returns
  • Constructor
  • Parameters
  • initialValue
  • Returns
  • Accessors
  • state
  • Get Signature
  • Returns
  • Methods
  • get()
  • Returns
  • setState()
  • Parameters
  • updater
  • Returns
  • subscribe()
  • Parameters
  • observerOrFn
  • Returns
Learn about TanStack AdsHide Ads
PartnersBecome a Partner
CodeRabbitCodeRabbit
CloudflareCloudflare
AG GridAG Grid
NetlifyNetlify
NeonNeon
WorkOSWorkOS
ClerkClerk
ConvexConvex
ElectricElectric
PowerSyncPowerSync
SentrySentry
PrismaPrisma
StrapiStrapi
UnkeyUnkey
Learn about TanStack AdsHide Ads