Source: https://tanstack.com/store/latest/docs/reference/classes/derived

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

React

Version

Latest

Search...

+ K

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

• Classes / Derived
  
  core

• Classes / Effect
  
  core

• Interfaces / StoreOptions
  
  core

• Interfaces / DerivedOptions
  
  core

• React Reference
  
  react

• Functions / useStore
  
  react

• Functions / shallow
  
  react

Examples

• Simple
  
  react

Framework

React

Version

Latest

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

• Classes / Derived
  
  core

• Classes / Effect
  
  core

• Interfaces / StoreOptions
  
  core

• Interfaces / DerivedOptions
  
  core

• React Reference
  
  react

• Functions / useStore
  
  react

• Functions / shallow
  
  react

Examples

• Simple
  
  react

On this page

• Class: Derived<TState, TArr>

• Type Parameters

• Constructors

• new Derived()

• Parameters

• options

• Returns

• Properties

• lastSeenDepValues

• listeners

• options

• prevState

• state

• Methods

• checkIfRecalculationNeededDeeply()

• Returns

• getDepVals()

• Returns

• currDepVals

• prevDepVals

• prevVal

• mount()

• Returns

• Returns

• recompute()

• Returns

• registerOnGraph()

• Parameters

• deps

• Returns

• subscribe()

• Parameters

• listener

• Returns

• Returns

• unregisterFromGraph()

• Parameters

• deps

• Returns

Derived

Copy Markdown

Class: Derived<TState, TArr>
============================

Defined in: derived.ts:61

Type Parameters
---------------

• TState

• TArr extends ReadonlyArray<Derived <any> | Store <any>> = ReadonlyArray<any>

Constructors
------------ ### new Derived()

ts

new Derived<TState, TArr>(options): Derived<TState, TArr>


new Derived<TState, TArr>(options): Derived<TState, TArr>

Defined in: derived.ts:96

#### Parameters ##### options

DerivedOptions <TState, TArr>

#### Returns

Derived <TState, TArr>

Properties
---------- ### lastSeenDepValues

ts

lastSeenDepValues: unknown[] = [];


lastSeenDepValues: unknown[] = [];

Defined in: derived.ts:78

---

### listeners

ts

listeners: Set<Listener<TState>>;


listeners: Set<Listener<TState>>;

Defined in: derived.ts:67

---

### options

ts

options: DerivedOptions<TState, TArr>;


options: DerivedOptions<TState, TArr>;

Defined in: derived.ts:70

---

### prevState

ts

prevState: undefined | TState;


prevState: undefined | TState;

Defined in: derived.ts:69

---

### state

ts

state: TState;


state: TState;

Defined in: derived.ts:68

Methods
------- ### checkIfRecalculationNeededDeeply()

ts

checkIfRecalculationNeededDeeply(): void


checkIfRecalculationNeededDeeply(): void

Defined in: derived.ts:178

#### Returns

void

---

### getDepVals()

ts

getDepVals(): object


getDepVals(): object

Defined in: derived.ts:79

#### Returns

object

##### currDepVals

ts

currDepVals: unknown[];


currDepVals: unknown[];

##### prevDepVals

ts

prevDepVals: unknown[];


prevDepVals: unknown[];

##### prevVal

ts

prevVal: undefined | NonNullable<TState>;


prevVal: undefined | NonNullable<TState>;

---

### mount()

ts

mount(): () => void


mount(): () => void

Defined in: derived.ts:199

#### Returns

Function

##### Returns

void

---

### recompute()

ts

recompute(): void


recompute(): void

Defined in: derived.ts:170

#### Returns

void

---

### registerOnGraph()

ts

registerOnGraph(deps): void


registerOnGraph(deps): void

Defined in: derived.ts:105

#### Parameters ##### deps

readonly ( | Derived <any, readonly any[]> | Store <any, (cb) => any>)[] = ...

#### Returns

void

---

### subscribe()

ts

subscribe(listener): () => void


subscribe(listener): () => void

Defined in: derived.ts:211

#### Parameters ##### listener

Listener<TState>

#### Returns

Function

##### Returns

void

---

### unregisterFromGraph()

ts

unregisterFromGraph(deps): void


unregisterFromGraph(deps): void

Defined in: derived.ts:147

#### Parameters ##### deps

readonly ( | Derived <any, readonly any[]> | Store <any, (cb) => any>)[] = ...

#### Returns

void

Edit on GitHub

Classes / Store

Classes / Effect

Partners Become a Partner