Add Belt.Map.getOrThrow and Belt.MutableMap.getOrThrow

mediremi · mediremi · commit 7a6a13548887 · 2025-06-28T21:46:19.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,8 +49,10 @@
   - `List.headExn` → `List.headOrThrow`
   - `Belt.Array.getExn` → `Belt.Array.getOrThrow`
   - `Belt.Array.setExn` → `Belt.Array.setOrThrow`
+  - `Belt.Map.getExn` → `Belt.Map.getOrThrow`
+  - `Belt.MutableMap.getExn` → `Belt.MutableMap.getOrThrow`
   - Old functions remain available but are marked as deprecated with guidance to use the new `OrThrow` variants.
-  - https://github.com/rescript-lang/rescript/pull/7518, https://github.com/rescript-lang/rescript/pull/7554
+  - https://github.com/rescript-lang/rescript/pull/7518, https://github.com/rescript-lang/rescript/pull/7554, https://github.com/rescript-lang/rescript/pull/7581
 
 #### :rocket: New Feature
 
diff --git a/analysis/reanalyze/src/ExnLib.ml b/analysis/reanalyze/src/ExnLib.ml
@@ -12,7 +12,7 @@ let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
   let beltList =
     [("getExn", [notFound]); ("headExn", [notFound]); ("tailExn", [notFound])]
   in
-  let beltMap = [("getExn", [notFound])] in
+  let beltMap = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
   let beltMutableMap = beltMap in
   let beltMutableQueue = [("peekExn", [notFound]); ("popExn", [notFound])] in
   let beltMutableSet = [("getExn", [notFound])] in
diff --git a/lib/es6/Belt_Map.js b/lib/es6/Belt_Map.js
@@ -215,8 +215,8 @@ function getWithDefault(map, x, def) {
   return Belt_MapDict.getWithDefault(map.data, x, def, map.cmp);
 }
 
-function getExn(map, x) {
-  return Belt_MapDict.getExn(map.data, x, map.cmp);
+function getOrThrow(map, x) {
+  return Belt_MapDict.getOrThrow(map.data, x, map.cmp);
 }
 
 function has(map, x) {
@@ -273,6 +273,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mergeU = merge;
@@ -324,6 +326,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   remove,
   removeMany,
   set,
diff --git a/lib/es6/Belt_MapDict.js b/lib/es6/Belt_MapDict.js
@@ -326,7 +326,9 @@ let getUndefined = Belt_internalAVLtree.getUndefined;
 
 let getWithDefault = Belt_internalAVLtree.getWithDefault;
 
-let getExn = Belt_internalAVLtree.getExn;
+let getExn = Belt_internalAVLtree.getOrThrow;
+
+let getOrThrow = Belt_internalAVLtree.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLtree.checkInvariantInternal;
 
@@ -386,6 +388,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,
diff --git a/lib/es6/Belt_MutableMap.js b/lib/es6/Belt_MutableMap.js
@@ -257,8 +257,8 @@ function getWithDefault(m, x, def) {
   return Belt_internalAVLtree.getWithDefault(m.data, x, def, m.cmp);
 }
 
-function getExn(m, x) {
-  return Belt_internalAVLtree.getExn(m.data, x, m.cmp);
+function getOrThrow(m, x) {
+  return Belt_internalAVLtree.getOrThrow(m.data, x, m.cmp);
 }
 
 function has(m, x) {
@@ -318,6 +318,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mapU = map;
@@ -361,6 +363,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,
diff --git a/lib/es6/Belt_internalAVLtree.js b/lib/es6/Belt_internalAVLtree.js
@@ -837,7 +837,7 @@ function getUndefined(_n, x, cmp) {
   };
 }
 
-function getExn(_n, x, cmp) {
+function getOrThrow(_n, x, cmp) {
   while (true) {
     let n = _n;
     if (n !== undefined) {
@@ -1062,7 +1062,7 @@ export {
   get,
   getUndefined,
   getWithDefault,
-  getExn,
+  getOrThrow,
   has,
   fromArray,
   updateMutate,
diff --git a/lib/js/Belt_Map.js b/lib/js/Belt_Map.js
@@ -215,8 +215,8 @@ function getWithDefault(map, x, def) {
   return Belt_MapDict.getWithDefault(map.data, x, def, map.cmp);
 }
 
-function getExn(map, x) {
-  return Belt_MapDict.getExn(map.data, x, map.cmp);
+function getOrThrow(map, x) {
+  return Belt_MapDict.getOrThrow(map.data, x, map.cmp);
 }
 
 function has(map, x) {
@@ -273,6 +273,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mergeU = merge;
@@ -323,6 +325,7 @@ exports.get = get;
 exports.getUndefined = getUndefined;
 exports.getWithDefault = getWithDefault;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.remove = remove;
 exports.removeMany = removeMany;
 exports.set = set;
diff --git a/lib/js/Belt_MapDict.js b/lib/js/Belt_MapDict.js
@@ -326,7 +326,9 @@ let getUndefined = Belt_internalAVLtree.getUndefined;
 
 let getWithDefault = Belt_internalAVLtree.getWithDefault;
 
-let getExn = Belt_internalAVLtree.getExn;
+let getExn = Belt_internalAVLtree.getOrThrow;
+
+let getOrThrow = Belt_internalAVLtree.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLtree.checkInvariantInternal;
 
@@ -385,6 +387,7 @@ exports.get = get;
 exports.getUndefined = getUndefined;
 exports.getWithDefault = getWithDefault;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.checkInvariantInternal = checkInvariantInternal;
 exports.remove = remove;
 exports.removeMany = removeMany;
diff --git a/lib/js/Belt_MutableMap.js b/lib/js/Belt_MutableMap.js
@@ -257,8 +257,8 @@ function getWithDefault(m, x, def) {
   return Belt_internalAVLtree.getWithDefault(m.data, x, def, m.cmp);
 }
 
-function getExn(m, x) {
-  return Belt_internalAVLtree.getExn(m.data, x, m.cmp);
+function getOrThrow(m, x) {
+  return Belt_internalAVLtree.getOrThrow(m.data, x, m.cmp);
 }
 
 function has(m, x) {
@@ -318,6 +318,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mapU = map;
@@ -360,6 +362,7 @@ exports.get = get;
 exports.getUndefined = getUndefined;
 exports.getWithDefault = getWithDefault;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.checkInvariantInternal = checkInvariantInternal;
 exports.remove = remove;
 exports.removeMany = removeMany;
diff --git a/lib/js/Belt_internalAVLtree.js b/lib/js/Belt_internalAVLtree.js
@@ -837,7 +837,7 @@ function getUndefined(_n, x, cmp) {
   };
 }
 
-function getExn(_n, x, cmp) {
+function getOrThrow(_n, x, cmp) {
   while (true) {
     let n = _n;
     if (n !== undefined) {
@@ -1061,7 +1061,7 @@ exports.eq = eq;
 exports.get = get;
 exports.getUndefined = getUndefined;
 exports.getWithDefault = getWithDefault;
-exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.has = has;
 exports.fromArray = fromArray;
 exports.updateMutate = updateMutate;
diff --git a/runtime/Belt_Map.res b/runtime/Belt_Map.res
@@ -123,7 +123,9 @@ let getUndefined = (map, x) => Dict.getUndefined(~cmp=map.cmp, map.data, x)
 
 let getWithDefault = (map, x, def) => Dict.getWithDefault(~cmp=map.cmp, map.data, x, def)
 
-let getExn = (map, x) => Dict.getExn(~cmp=map.cmp, map.data, x)
+let getOrThrow = (map, x) => Dict.getOrThrow(~cmp=map.cmp, map.data, x)
+
+let getExn = getOrThrow
 
 let has = (map, x) => Dict.has(~cmp=map.cmp, map.data, x)
 
diff --git a/runtime/Belt_Map.resi b/runtime/Belt_Map.resi
@@ -379,12 +379,22 @@ let getWithDefault: (t<'k, 'v, 'id>, 'k, 'v) => 'v
 /** 
 `getExn(s, k)`
 
-See `Belt.Map.getExn`
+See `Belt.Map.get`
 
 raise when `k` not exist
 */
+@deprecated("Use `getOrThrow` instead")
 let getExn: (t<'k, 'v, 'id>, 'k) => 'v
 
+/**
+`getOrThrow(s, k)`
+
+See `Belt.Map.get`
+
+raise when `k` not exist
+*/
+let getOrThrow: (t<'k, 'v, 'id>, 'k) => 'v
+
 /* ************************************************************************** */
 
 /** 
diff --git a/runtime/Belt_MapDict.res b/runtime/Belt_MapDict.res
@@ -59,7 +59,8 @@ let maxUndefined = N.maxUndefined
 let get = N.get
 let getUndefined = N.getUndefined
 let getWithDefault = N.getWithDefault
-let getExn = N.getExn
+let getOrThrow = N.getOrThrow
+let getExn = getOrThrow
 
 let mapWithKey = N.mapWithKey
 
diff --git a/runtime/Belt_MapDict.resi b/runtime/Belt_MapDict.resi
@@ -153,8 +153,11 @@ let getUndefined: (t<'k, 'a, 'id>, 'k, ~cmp: cmp<'k, 'id>) => Js.undefined<'a>
 
 let getWithDefault: (t<'k, 'a, 'id>, 'k, 'a, ~cmp: cmp<'k, 'id>) => 'a
 
+@deprecated("Use `getOrThrow` instead")
 let getExn: (t<'k, 'a, 'id>, 'k, ~cmp: cmp<'k, 'id>) => 'a
 
+let getOrThrow: (t<'k, 'a, 'id>, 'k, ~cmp: cmp<'k, 'id>) => 'a
+
 let checkInvariantInternal: t<_> => unit
 
 /**
diff --git a/runtime/Belt_MutableMap.res b/runtime/Belt_MutableMap.res
@@ -190,7 +190,9 @@ let getUndefined = (m, x) => N.getUndefined(~cmp=m.cmp, m.data, x)
 
 let getWithDefault = (m, x, def) => N.getWithDefault(~cmp=m.cmp, m.data, x, def)
 
-let getExn = (m, x) => N.getExn(~cmp=m.cmp, m.data, x)
+let getOrThrow = (m, x) => N.getOrThrow(~cmp=m.cmp, m.data, x)
+
+let getExn = getOrThrow
 
 let has = (m, x) => N.has(~cmp=m.cmp, m.data, x)
 
diff --git a/runtime/Belt_MutableMap.resi b/runtime/Belt_MutableMap.resi
@@ -120,7 +120,9 @@ let maxUndefined: t<'k, 'a, _> => Js.undefined<('k, 'a)>
 let get: (t<'k, 'a, 'id>, 'k) => option<'a>
 let getUndefined: (t<'k, 'a, 'id>, 'k) => Js.undefined<'a>
 let getWithDefault: (t<'k, 'a, 'id>, 'k, 'a) => 'a
+@deprecated("Use `getOrThrow` instead")
 let getExn: (t<'k, 'a, 'id>, 'k) => 'a
+let getOrThrow: (t<'k, 'a, 'id>, 'k) => 'a
 /** Raise when invariant is not held. */
 let checkInvariantInternal: t<_> => unit
 
diff --git a/runtime/Belt_internalAVLtree.res b/runtime/Belt_internalAVLtree.res
@@ -711,7 +711,7 @@ let rec getUndefined = (n, x, ~cmp) =>
     }
   }
 
-let rec getExn = (n, x, ~cmp) =>
+let rec getOrThrow = (n, x, ~cmp) =>
   switch n {
   | None => throw(Not_found)
   | Some(n) /* Node(l, v, d, r, _) */ =>
@@ -720,7 +720,7 @@ let rec getExn = (n, x, ~cmp) =>
     if c == 0 {
       n.value
     } else {
-      getExn(
+      getOrThrow(
         ~cmp,
         if c < 0 {
           n.left
diff --git a/runtime/Belt_internalAVLtree.resi b/runtime/Belt_internalAVLtree.resi
@@ -114,7 +114,7 @@ let get: (t<'a, 'b>, 'a, ~cmp: cmp<'a, _>) => option<'b>
 let getUndefined: (t<'a, 'b>, 'a, ~cmp: cmp<'a, _>) => Js.undefined<'b>
 
 let getWithDefault: (t<'a, 'b>, 'a, 'b, ~cmp: cmp<'a, _>) => 'b
-let getExn: (t<'a, 'b>, 'a, ~cmp: cmp<'a, _>) => 'b
+let getOrThrow: (t<'a, 'b>, 'a, ~cmp: cmp<'a, _>) => 'b
 
 let has: (t<'a, 'b>, 'a, ~cmp: cmp<'a, _>) => bool
 
