Support using ObservableMap like it's a Record

LegendApp · Sep 16, 2024 · 76b8682 · 76b8682
1 parent 065e14c
commit 76b8682
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 6 deletions.
diff --git a/src/observableTypes.ts b/src/observableTypes.ts
@@ -53,8 +53,9 @@ interface ObservableObjectFunctions<T = Record<string, any>> extends ObservableP
 
 type MapKey<T extends Map<any, any> | WeakMap<any, any>> = Parameters<T['has']>[0];
 type MapValue<T extends Map<any, any> | WeakMap<any, any>> = ReturnType<T['get']>;
-type ObservableMap<T extends Map<any, any> | WeakMap<any, any>> = Omit<T, 'get' | 'size' | 'set'> &
-    Omit<ObservablePrimitive<T>, 'get' | 'size'> & {
+export type ObservableMap<T extends Map<any, any> | WeakMap<any, any>> = Omit<T, 'get' | 'size' | 'set'> &
+    Omit<ObservablePrimitive<T>, 'get' | 'size'> &
+    Record<MapKey<T>, Observable<MapValue<T>>> & {
         get(key: Parameters<T['get']>[0]): Observable<Parameters<T['set']>[1]>;
         get(): T;
         size: number;

diff --git a/tests/mapset.test.ts b/tests/mapset.test.ts
@@ -79,6 +79,14 @@ describe('Map default behavior', () => {
             ]),
         );
     });
+    test('Map get like object', () => {
+        const obs = observable({ test: new Map([['key', 'value']]) });
+
+        expect(isObservable(obs.test)).toEqual(true);
+        expect(isObservable(obs.test['key'])).toEqual(true);
+        expect(obs.test['key'].get()).toEqual('value');
+        expect(obs.test.get()).toBeInstanceOf(Map);
+    });
 });
 
 describe('Map is observable', () => {

diff --git a/tests/types.test.ts b/tests/types.test.ts
@@ -1,5 +1,11 @@
 import { expectTypeOf } from 'expect-type';
-import { Observable, ObservableBoolean, ObservableParam, ObservablePrimitive } from '../src/observableTypes';
+import {
+    Observable,
+    ObservableBoolean,
+    ObservableMap,
+    ObservableParam,
+    ObservablePrimitive,
+} from '../src/observableTypes';
 import { observable } from '../src/observable';
 
 describe('observable', () => {
@@ -300,9 +306,19 @@ describe('with function', () => {
     });
 });
 
-it('should infer Map', () => {
-    type GetState = Observable<Map<string, number>>['get'];
-    expectTypeOf<GetState>().returns.toEqualTypeOf<Map<string, number>>();
+describe('with Map', () => {
+    it('should infer Map', () => {
+        type GetState = Observable<Map<string, number>>['get'];
+        expectTypeOf<GetState>().returns.toEqualTypeOf<Map<string, number>>();
+    });
+    it('should infer Map', () => {
+        type Type = Observable<Map<string, number>>;
+        expectTypeOf<Type>().toEqualTypeOf<ObservableMap<Map<string, number>>>();
+
+        const obs = observable({ test: new Map<string, number>() });
+        type Type2 = typeof obs.test;
+        expectTypeOf<Type2>().toEqualTypeOf<ObservableMap<Map<string, number>>>();
+    });
 });
 
 describe('with maybe undefined', () => {