TanStack
Store v0v0
AlphaTry TanStack CLI
Log In
StartRC
StartRC
Router
Router
Query
Query
Table
Table
DBbeta
DBbeta
AIalpha
AIalpha
Formnew
Formnew
Virtual
Virtual
Pacerbeta
Pacerbeta
Hotkeysalpha
Hotkeysalpha
Storealpha
Storealpha
Devtoolsalpha
Devtoolsalpha
CLIalpha
CLIalpha
More Libraries
More Libraries
BuilderAlpha
BuilderAlpha
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
SerpAPISerpAPI
NetlifyNetlify
NeonNeon
WorkOSWorkOS
ClerkClerk
ConvexConvex
ElectricElectric
PowerSyncPowerSync
SentrySentry
RailwayRailway
PrismaPrisma
StrapiStrapi
UnkeyUnkey
CodeRabbitCodeRabbit
CloudflareCloudflare
AG GridAG Grid
SerpAPISerpAPI
NetlifyNetlify
NeonNeon
WorkOSWorkOS
ClerkClerk
ConvexConvex
ElectricElectric
PowerSyncPowerSync
SentrySentry
RailwayRailway
PrismaPrisma
StrapiStrapi
UnkeyUnkey
Menu
  • Home
  • Frameworks
  • Contributors
  • NPM Stats
  • 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
  • NPM Stats
  • 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
AI/LLM: This documentation page is available in plain markdown format at/store/latest/docs/reference/classes/ReadonlyStore.md
Learn about TanStack AdsHide Ads

ReadonlyStore

Class: ReadonlyStore<T>

Defined in: store.ts:31

Type Parameters

T

T

Implements

  • Omit<Store<T>, "setState">

Constructors

Constructor

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

Defined in: store.ts:33

Parameters

getValue

(prev?) => T

Returns

ReadonlyStore<T>

Constructor

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

Defined in: store.ts:34

Parameters

initialValue

T

Returns

ReadonlyStore<T>

Accessors

state

Get Signature

ts
get state(): T;

Defined in: store.ts:42

Returns

T

Implementation of

ts
Omit.state

Methods

get()

ts
get(): T;

Defined in: store.ts:45

Returns

T

Implementation of

ts
Omit.get

subscribe()

ts
subscribe(observerOrFn): Subscription;

Defined in: store.ts:48

Parameters

observerOrFn

Observer<T> | (value) => void

Returns

Subscription

Implementation of

ts
Omit.subscribe
Edit on GitHub
NextHome

On this page

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