TS: update method may return undefined (#1933)

immutable-js · Feb 9, 2023 · f88e4f9 · f88e4f9
1 parent af0a387
commit f88e4f9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/type-definitions/immutable.d.ts b/type-definitions/immutable.d.ts
@@ -424,7 +424,10 @@ declare namespace Immutable {
      * @see `Map#update`
      */
     update(index: number, notSetValue: T, updater: (value: T) => T): this;
-    update(index: number, updater: (value: T | undefined) => T): this;
+    update(
+      index: number,
+      updater: (value: T | undefined) => T | undefined
+    ): this;
     update<R>(updater: (value: this) => R): R;
 
     /**
@@ -1001,7 +1004,7 @@ declare namespace Immutable {
      * Note: `update(key)` can be used in `withMutations`.
      */
     update(key: K, notSetValue: V, updater: (value: V) => V): this;
-    update(key: K, updater: (value: V | undefined) => V): this;
+    update(key: K, updater: (value: V | undefined) => V | undefined): this;
     update<R>(updater: (value: this) => R): R;
 
     /**
@@ -5571,7 +5574,7 @@ declare namespace Immutable {
   function update<K, V, C extends Collection<K, V>>(
     collection: C,
     key: K,
-    updater: (value: V | undefined) => V
+    updater: (value: V | undefined) => V | undefined
   ): C;
   function update<K, V, C extends Collection<K, V>, NSV>(
     collection: C,
@@ -5598,7 +5601,7 @@ declare namespace Immutable {
   function update<V>(
     collection: Array<V>,
     key: number,
-    updater: (value: V) => V
+    updater: (value: V | undefined) => V | undefined
   ): Array<V>;
   function update<V, NSV>(
     collection: Array<V>,

diff --git a/type-definitions/ts-tests/list.ts b/type-definitions/ts-tests/list.ts
@@ -265,6 +265,9 @@ import {
   // $ExpectError
   List<number>().update(1, 10, (v: number | undefined) => v + 'a');
 
+  // $ExpectType List<string>
+  List<string>().update(1, (v) => v?.toUpperCase());
+
   // $ExpectType List<number>
   update(List<number>(), 0, (v: number | undefined) => 0);
 

diff --git a/type-definitions/ts-tests/map.ts b/type-definitions/ts-tests/map.ts
@@ -176,6 +176,9 @@ import { Map, List } from 'immutable';
 
   // $ExpectError
   Map<number, number>().update(1, 10, (v: number | undefined) => v + 'a');
+
+  // $ExpectType Map<string, string>
+  Map<string, string>().update("noKey", ls => ls?.toUpperCase());
 }
 
 {