Add Belt.Array.getOrThrow and setOrThrow

Author: mediremi

CHANGELOG.md

@@ -47,6 +47,8 @@
   - `List.getExn` → `List.getOrThrow`
   - `List.tailExn` → `List.tailOrThrow`
   - `List.headExn` → `List.headOrThrow`
+  - `Belt.Array.getExn` → `Belt.Array.getOrThrow`
+  - `Belt.Array.setExn` → `Belt.Array.setOrThrow`
   - 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
 

analysis/reanalyze/src/ExnLib.ml

@@ -1,7 +1,14 @@
 let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
   let table = Hashtbl.create 15 in
   let open Exn in
-  let beltArray = [("getExn", [assertFailure]); ("setExn", [assertFailure])] in
+  let beltArray =
+    [
+      ("getExn", [assertFailure]);
+      ("getOrThrow", [assertFailure]);
+      ("setExn", [assertFailure]);
+      ("setOrThrow", [assertFailure]);
+    ]
+  in
   let beltList =
     [("getExn", [notFound]); ("headExn", [notFound]); ("tailExn", [notFound])]
   in

lib/es6/Belt_Array.js

@@ -10,7 +10,7 @@ function get(arr, i) {
 
 }
 
-function getExn(arr, i) {
+function getOrThrow(arr, i) {
   if (!(i >= 0 && i < arr.length)) {
     throw {
       RE_EXN_ID: "Assert_failure",
@@ -34,13 +34,13 @@ function set(arr, i, v) {
   }
 }
 
-function setExn(arr, i, v) {
+function setOrThrow(arr, i, v) {
   if (!(i >= 0 && i < arr.length)) {
     throw {
       RE_EXN_ID: "Assert_failure",
       _1: [
         "Belt_Array.res",
-        49,
+        51,
         2
       ],
       Error: new Error()
@@ -582,6 +582,10 @@ function init(n, f) {
   return v;
 }
 
+let getExn = getOrThrow;
+
+let setExn = setOrThrow;
+
 let makeByU = makeBy;
 
 let makeByAndShuffleU = makeByAndShuffle;
@@ -637,8 +641,10 @@ let initU = init;
 export {
   get,
   getExn,
+  getOrThrow,
   set,
   setExn,
+  setOrThrow,
   shuffleInPlace,
   shuffle,
   reverseInPlace,

lib/js/Belt_Array.js

@@ -10,7 +10,7 @@ function get(arr, i) {
 
 }
 
-function getExn(arr, i) {
+function getOrThrow(arr, i) {
   if (!(i >= 0 && i < arr.length)) {
     throw {
       RE_EXN_ID: "Assert_failure",
@@ -34,13 +34,13 @@ function set(arr, i, v) {
   }
 }
 
-function setExn(arr, i, v) {
+function setOrThrow(arr, i, v) {
   if (!(i >= 0 && i < arr.length)) {
     throw {
       RE_EXN_ID: "Assert_failure",
       _1: [
         "Belt_Array.res",
-        49,
+        51,
         2
       ],
       Error: new Error()
@@ -582,6 +582,10 @@ function init(n, f) {
   return v;
 }
 
+let getExn = getOrThrow;
+
+let setExn = setOrThrow;
+
 let makeByU = makeBy;
 
 let makeByAndShuffleU = makeByAndShuffle;
@@ -636,8 +640,10 @@ let initU = init;
 
 exports.get = get;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.set = set;
 exports.setExn = setExn;
+exports.setOrThrow = setOrThrow;
 exports.shuffleInPlace = shuffleInPlace;
 exports.shuffle = shuffle;
 exports.reverseInPlace = reverseInPlace;

runtime/Belt_Array.res

@@ -32,11 +32,13 @@ let get = (arr, i) =>
     None
   }
 
-let getExn = (arr, i) => {
+let getOrThrow = (arr, i) => {
   assert(i >= 0 && i < length(arr))
   getUnsafe(arr, i)
 }
 
+let getExn = getOrThrow
+
 let set = (arr, i, v) =>
   if i >= 0 && i < length(arr) {
     setUnsafe(arr, i, v)
@@ -45,11 +47,13 @@ let set = (arr, i, v) =>
     false
   }
 
-let setExn = (arr, i, v) => {
+let setOrThrow = (arr, i, v) => {
   assert(i >= 0 && i < length(arr))
   setUnsafe(arr, i, v)
 }
 
+let setExn = setOrThrow
+
 @set external truncateToLengthUnsafe: (t<'a>, int) => unit = "length"
 
 @new external makeUninitialized: int => array<Js.undefined<'a>> = "Array"

runtime/Belt_Array.resi

@@ -50,8 +50,15 @@ let get: (t<'a>, int) => option<'a>
 Raise an exception if `i` is out of range.
 Otherwise return the value at index `i` in `arr`.
 */
+@deprecated("Use 'getOrThrow' instead")
 let getExn: (t<'a>, int) => 'a
 
+/**
+Raise an exception if `i` is out of range.
+Otherwise return the value at index `i` in `arr`.
+*/
+let getOrThrow: (t<'a>, int) => 'a
+
 /**
 `getUnsafe(arr, i)`
 
@@ -79,8 +86,14 @@ let set: (t<'a>, int, 'a) => bool
 /**
 `setExn(arr, i, x)` raise an exception if `i` is out of range.
 */
+@deprecated("Use 'setOrThrow' instead")
 let setExn: (t<'a>, int, 'a) => unit
 
+/**
+`setOrThrow(arr, i, x)` raise an exception if `i` is out of range.
+*/
+let setOrThrow: (t<'a>, int, 'a) => unit
+
 external setUnsafe: (t<'a>, int, 'a) => unit = "%array_unsafe_set"
 
 /**

tests/tests/src/module_missing_conversion.mjs

@@ -10,8 +10,10 @@ function f(x) {
 let XX = {
   get: Belt_Array.get,
   getExn: Belt_Array.getExn,
+  getOrThrow: Belt_Array.getOrThrow,
   set: Belt_Array.set,
   setExn: Belt_Array.setExn,
+  setOrThrow: Belt_Array.setOrThrow,
   shuffleInPlace: Belt_Array.shuffleInPlace,
   shuffle: Belt_Array.shuffle,
   reverseInPlace: Belt_Array.reverseInPlace,

tests/tests/src/test_simple_include.mjs

@@ -26,10 +26,14 @@ let get = Belt_Array.get;
 
 let getExn = Belt_Array.getExn;
 
+let getOrThrow = Belt_Array.getOrThrow;
+
 let set = Belt_Array.set;
 
 let setExn = Belt_Array.setExn;
 
+let setOrThrow = Belt_Array.setOrThrow;
+
 let shuffleInPlace = Belt_Array.shuffleInPlace;
 
 let shuffle = Belt_Array.shuffle;
@@ -171,8 +175,10 @@ let a = 3;
 export {
   get,
   getExn,
+  getOrThrow,
   set,
   setExn,
+  setOrThrow,
   shuffleInPlace,
   shuffle,
   reverseInPlace,