TanStackStore v0
Auto
Framework
Version
Menu
  • Home
  • Frameworks
  • Contributors
  • GitHub
  • Discord
Getting Started
  • Overview
    core
  • Installation
    core
  • Quick Start
    core
  • Quick Start
    react
API Reference
  • JavaScript Reference
    core
  • Classes / Store
    core
  • Interfaces / Atom
    core
  • Interfaces / AtomOptions
    core
  • Interfaces / BaseAtom
    core
  • Interfaces / InternalBaseAtom
    core
  • Interfaces / InternalReadonlyAtom
    core
  • Interfaces / InteropSubscribable
    core
  • Interfaces / Readable
    core
  • Interfaces / ReadonlyAtom
    core
  • Interfaces / Subscribable
    core
  • Interfaces / Subscription
    core
  • Type Aliases / AnyAtom
    core
  • Type Aliases / Observer
    core
  • Type Aliases / Selection
    core
  • Functions / batch
    core
  • Functions / createAsyncAtom
    core
  • Functions / createAtom
    core
  • Functions / createStore
    core
  • Functions / flush
    core
  • Functions / toObserver
    core
  • React Reference
    react
  • Functions / useStore
    react
  • Functions / shallow
    react
Examples
  • Simple
    react
TanStackStore v0
Auto
Framework
Version
Menu
  • Home
  • Frameworks
  • Contributors
  • GitHub
  • Discord
Getting Started
  • Overview
    core
  • Installation
    core
  • Quick Start
    core
  • Quick Start
    react
API Reference
  • JavaScript Reference
    core
  • Classes / Store
    core
  • Interfaces / Atom
    core
  • Interfaces / AtomOptions
    core
  • Interfaces / BaseAtom
    core
  • Interfaces / InternalBaseAtom
    core
  • Interfaces / InternalReadonlyAtom
    core
  • Interfaces / InteropSubscribable
    core
  • Interfaces / Readable
    core
  • Interfaces / ReadonlyAtom
    core
  • Interfaces / Subscribable
    core
  • Interfaces / Subscription
    core
  • Type Aliases / AnyAtom
    core
  • Type Aliases / Observer
    core
  • Type Aliases / Selection
    core
  • Functions / batch
    core
  • Functions / createAsyncAtom
    core
  • Functions / createAtom
    core
  • Functions / createStore
    core
  • Functions / flush
    core
  • Functions / toObserver
    core
  • React Reference
    react
  • Functions / useStore
    react
  • Functions / shallow
    react
Examples
  • Simple
    react
On this page
  • Class: Store<T>
  • 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

Store

Class: Store<T>

Defined in: store.ts:4

Type Parameters

T

T

Constructors

Constructor

ts
new Store<T>(getValue): Store<T>;
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>;
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;
get state(): T;

Defined in: store.ts:18

Returns

T

Methods

get()

ts
get(): T;
get(): T;

Defined in: store.ts:21

Returns

T


setState()

ts
setState(updater): void;
setState(updater): void;

Defined in: store.ts:15

Parameters

updater

(prev) => T

Returns

void


subscribe()

ts
subscribe(observerOrFn): Subscription;
subscribe(observerOrFn): Subscription;

Defined in: store.ts:24

Parameters

observerOrFn

Observer<T> | (value) => void

Returns

Subscription

Edit on GitHub

On this page

  • Class: Store<T>
  • 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
JavaScript Reference
Interfaces / Atom
Our Partners
Wow, it looks like you could be our first partner for this library! Chat with us!
TanStackPacer
Set the pace of interactions in your applications. Limit the rate at which functions can fire, or intelligently queue long-running tasks with Concurrency Control.
TanStackConfig
The build and publish utilities used by all of our projects. Use it if you dare!