Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/reference/classes/Derived.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Defined in: [derived.ts:61](https://github.com/TanStack/store/blob/main/packages
new Derived<TState, TArr>(options): Derived<TState, TArr>;
```

Defined in: [derived.ts:96](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L96)
Defined in: [derived.ts:95](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L95)

#### Parameters

Expand All @@ -45,7 +45,7 @@ Defined in: [derived.ts:96](https://github.com/TanStack/store/blob/main/packages
lastSeenDepValues: unknown[] = [];
```

Defined in: [derived.ts:78](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L78)
Defined in: [derived.ts:77](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L77)

***

Expand All @@ -55,7 +55,7 @@ Defined in: [derived.ts:78](https://github.com/TanStack/store/blob/main/packages
listeners: Set<Listener<TState>>;
```

Defined in: [derived.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L67)
Defined in: [derived.ts:66](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L66)

***

Expand All @@ -65,7 +65,7 @@ Defined in: [derived.ts:67](https://github.com/TanStack/store/blob/main/packages
options: DerivedOptions<TState, TArr>;
```

Defined in: [derived.ts:70](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L70)
Defined in: [derived.ts:69](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L69)

***

Expand All @@ -75,7 +75,7 @@ Defined in: [derived.ts:70](https://github.com/TanStack/store/blob/main/packages
prevState: TState | undefined;
```

Defined in: [derived.ts:69](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L69)
Defined in: [derived.ts:68](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L68)

***

Expand All @@ -85,7 +85,7 @@ Defined in: [derived.ts:69](https://github.com/TanStack/store/blob/main/packages
state: TState;
```

Defined in: [derived.ts:68](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L68)
Defined in: [derived.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L67)

## Methods

Expand All @@ -95,7 +95,7 @@ Defined in: [derived.ts:68](https://github.com/TanStack/store/blob/main/packages
checkIfRecalculationNeededDeeply(): void;
```

Defined in: [derived.ts:178](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L178)
Defined in: [derived.ts:177](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L177)

#### Returns

Expand All @@ -109,7 +109,7 @@ Defined in: [derived.ts:178](https://github.com/TanStack/store/blob/main/package
getDepVals(): object;
```

Defined in: [derived.ts:79](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L79)
Defined in: [derived.ts:78](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L78)

#### Returns

Expand Down Expand Up @@ -141,7 +141,7 @@ prevVal: NonNullable<TState> | undefined;
mount(): () => void;
```

Defined in: [derived.ts:199](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L199)
Defined in: [derived.ts:198](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L198)

#### Returns

Expand All @@ -161,7 +161,7 @@ Defined in: [derived.ts:199](https://github.com/TanStack/store/blob/main/package
recompute(): void;
```

Defined in: [derived.ts:170](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L170)
Defined in: [derived.ts:169](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L169)

#### Returns

Expand All @@ -175,7 +175,7 @@ Defined in: [derived.ts:170](https://github.com/TanStack/store/blob/main/package
registerOnGraph(deps): void;
```

Defined in: [derived.ts:105](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L105)
Defined in: [derived.ts:104](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L104)

#### Parameters

Expand All @@ -197,7 +197,7 @@ readonly (
subscribe(listener): () => void;
```

Defined in: [derived.ts:211](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L211)
Defined in: [derived.ts:210](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L210)

#### Parameters

Expand All @@ -223,7 +223,7 @@ Defined in: [derived.ts:211](https://github.com/TanStack/store/blob/main/package
unregisterFromGraph(deps): void;
```

Defined in: [derived.ts:147](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L147)
Defined in: [derived.ts:146](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L146)

#### Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/classes/Effect.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Effect

# Class: Effect

Defined in: [effect.ts:17](https://github.com/TanStack/store/blob/main/packages/store/src/effect.ts#L17)
Defined in: [effect.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/effect.ts#L16)

## Constructors

Expand All @@ -15,7 +15,7 @@ Defined in: [effect.ts:17](https://github.com/TanStack/store/blob/main/packages/
new Effect(opts): Effect;
```

Defined in: [effect.ts:23](https://github.com/TanStack/store/blob/main/packages/store/src/effect.ts#L23)
Defined in: [effect.ts:22](https://github.com/TanStack/store/blob/main/packages/store/src/effect.ts#L22)

#### Parameters

Expand All @@ -35,7 +35,7 @@ Defined in: [effect.ts:23](https://github.com/TanStack/store/blob/main/packages/
mount(): () => void;
```

Defined in: [effect.ts:39](https://github.com/TanStack/store/blob/main/packages/store/src/effect.ts#L39)
Defined in: [effect.ts:38](https://github.com/TanStack/store/blob/main/packages/store/src/effect.ts#L38)

#### Returns

Expand Down
9 changes: 4 additions & 5 deletions packages/store/src/derived.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ type UnwrapReadonlyDerivedOrStoreArray<
// Can't have currVal, as it's being evaluated from the current derived fn
export interface DerivedFnProps<
TArr extends ReadonlyArray<Derived<any> | Store<any>> = ReadonlyArray<any>,
TUnwrappedArr extends
UnwrapReadonlyDerivedOrStoreArray<TArr> = UnwrapReadonlyDerivedOrStoreArray<TArr>,
TUnwrappedArr extends UnwrapReadonlyDerivedOrStoreArray<TArr> =
UnwrapReadonlyDerivedOrStoreArray<TArr>,
> {
// `undefined` if it's the first run
/**
Expand Down Expand Up @@ -60,9 +60,8 @@ export interface DerivedOptions<

export class Derived<
TState,
const TArr extends ReadonlyArray<
Derived<any> | Store<any>
> = ReadonlyArray<any>,
const TArr extends ReadonlyArray<Derived<any> | Store<any>> =
ReadonlyArray<any>,
> {
listeners = new Set<Listener<TState>>()
state: TState
Expand Down
9 changes: 4 additions & 5 deletions packages/store/src/effect.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
import { Derived } from './derived'
import type { DerivedOptions } from './derived'

interface EffectOptions
extends Omit<
DerivedOptions<unknown>,
'onUpdate' | 'onSubscribe' | 'lazy' | 'fn'
> {
interface EffectOptions extends Omit<
DerivedOptions<unknown>,
'onUpdate' | 'onSubscribe' | 'lazy' | 'fn'
> {
/**
* Should the effect trigger immediately?
* @default false
Expand Down
Loading
Loading