Skip to content

Commit 4826b9e

Browse files
committed
refactor(store): improve store types
store.ts: Added bigint and symbol to `NotWrappable`. Simplified `DeepReadonly<T>`. `Store<T>` is now an alias for `DeepReadonly<T>`. Refactored `Part`, `Next`, and `SetStoreFunction` to improve their performance. Changed `NullableNext` to `Next`, and `Next` to `WrappableNext`. `WrappableNext` excludes all non-wrappable types instead of just non-nullable types, so `{a: number | {b: number}}` now allows `setStore("a", "b", 1)`. Omitted irrelevant overloads for `SetStoreFunction<T>` i.e. a store of `{a: 1}` now only has two overloads: just a setter, and a key then setter. store.spec.ts Added a few test cases for store types. modifiers.ts Improved types of `reconcile` and `produce`; the latter now correctly infers types. index.ts Removed the `Readonly` export. Added `WrappableNext`. fixes solidjs#732
1 parent c9307f0 commit 4826b9e

4 files changed

Lines changed: 319 additions & 177 deletions

File tree

‎packages/solid/store/src/index.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ export type {
99
ArrayFilterFn,
1010
Part,
1111
Next,
12-
Readonly,
12+
WrappableNext,
1313
DeepReadonly
1414
} from "./store";
1515
export * from "./mutable";
16-
export * from "./modifiers";
16+
export * from "./modifiers";

‎packages/solid/store/src/modifiers.ts‎

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
import {
2-
setProperty,
3-
unwrap,
4-
isWrappable,
5-
Store,
6-
NotWrappable,
7-
StoreNode,
8-
DeepReadonly,
9-
$RAW,
10-
} from "./store";
1+
import { setProperty, unwrap, isWrappable, Store, StoreNode, $RAW } from "./store";
112

123
export type ReconcileOptions = {
134
key?: string | null;
@@ -113,16 +104,13 @@ function applyState(
113104

114105
// Diff method for setState
115106
export function reconcile<T>(
116-
value: T | Store<T>,
107+
value: T,
117108
options: ReconcileOptions = {}
118-
): (
119-
state: T extends NotWrappable ? T : Store<DeepReadonly<T>>
120-
) => T extends NotWrappable ? T : Store<T> {
109+
): (state: Store<T>) => Store<T> {
121110
const { merge, key = "id" } = options,
122111
v = unwrap(value);
123-
return s => {
124-
const state = s as T extends NotWrappable ? T : Store<T>;
125-
if (!isWrappable(state) || !isWrappable(v)) return v as T extends NotWrappable ? T : Store<T>;
112+
return state => {
113+
if (!isWrappable(state) || !isWrappable(v)) return v as Store<T>;
126114
applyState(v, { state }, "state", merge, key);
127115
return state;
128116
};
@@ -147,13 +135,8 @@ const setterTraps: ProxyHandler<StoreNode> = {
147135
};
148136

149137
// Immer style mutation style
150-
export function produce<T>(
151-
fn: (state: T) => void
152-
): (
153-
state: T extends NotWrappable ? T : Store<DeepReadonly<T>>
154-
) => T extends NotWrappable ? T : Store<T> {
155-
return s => {
156-
const state = s as T extends NotWrappable ? T : Store<T>;
138+
export function produce<T>(fn: (state: T) => void): (state: Store<T>) => Store<T> {
139+
return state => {
157140
if (isWrappable(state)) fn(new Proxy(state as object, setterTraps) as unknown as T);
158141
return state;
159142
};

0 commit comments

Comments
 (0)