Skip to content
Source
Sign inSign up
TanStack/store
Open History to see the last commit

derived.md

232 lines3.6 KB

Class: Derived<TState, TArr>

Defined in: derived.ts:54

Type Parameters

• TState

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

Constructors

new Derived()

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

Defined in: derived.ts:87

Parameters

options

DerivedOptions<TState, TArr>

Returns

Derived<TState, TArr>

Properties

lastSeenDepValues

lastSeenDepValues: unknown[] = [];

Defined in: derived.ts:71


listeners

listeners: Set<Listener<TState>>;

Defined in: derived.ts:60


options

options: DerivedOptions<TState, TArr>;

Defined in: derived.ts:63


prevState

prevState: undefined | TState;

Defined in: derived.ts:62


state

state: TState;

Defined in: derived.ts:61

Methods

checkIfRecalculationNeededDeeply()

checkIfRecalculationNeededDeeply(): void

Defined in: derived.ts:157

Returns

void


getDepVals()

getDepVals(): object

Defined in: derived.ts:72

Returns

object

currDepVals
currDepVals: unknown[];
prevDepVals
prevDepVals: unknown[];
prevVal
prevVal: undefined | NonNullable<TState>;

mount()

mount(): () => void

Defined in: derived.ts:178

Returns

Function

Returns

void


recompute()

recompute(): void

Defined in: derived.ts:145

Returns

void


registerOnGraph()

registerOnGraph(deps): void

Defined in: derived.ts:96

Parameters

deps

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

Returns

void


subscribe()

subscribe(listener): () => void

Defined in: derived.ts:190

Parameters

listener

Listener<TState>

Returns

Function

Returns

void


unregisterFromGraph()

unregisterFromGraph(deps): void

Defined in: derived.ts:125

Parameters

deps

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

Returns

void