Add Belt.Result.getOrThrow

Author: mediremi

CHANGELOG.md

@@ -59,6 +59,7 @@
   - `Belt.MutableQueue.peekExn` → `Belt.MutableQueue.peekOrThrow`
   - `Belt.MutableQueue.popExn` → `Belt.MutableQueue.popOrThrow`
   - `Belt.Option.getExn` → `Belt.Option.getOrThrow`
+  - `Belt.Result.getExn` → `Belt.Result.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/7581
 

analysis/reanalyze/src/ExnLib.ml

@@ -32,7 +32,7 @@ let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
   let beltSet = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
   let beltMutableSet = beltSet in
   let beltOption = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
-  let beltResult = [("getExn", [notFound])] in
+  let beltResult = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
   let bsJson =
     (* bs-json *)
     [

runtime/Belt_Result.res

@@ -26,12 +26,14 @@ type t<'a, 'b> = result<'a, 'b> =
   | Ok('a)
   | Error('b)
 
-let getExn = x =>
+let getOrThrow = x =>
   switch x {
   | Ok(x) => x
   | Error(_) => throw(Not_found)
   }
 
+let getExn = getOrThrow
+
 let mapWithDefault = (opt, default, f) =>
   switch opt {
   | Ok(x) => f(x)

runtime/Belt_Result.resi

@@ -50,8 +50,28 @@ switch Belt.Result.getExn(Belt.Result.Error("Invalid data")) { // raise a except
 }
 ```
 */
+@deprecated("Use `getOrThrow` instead")
 let getExn: t<'a, 'b> => 'a
 
+/**
+`getOrThrow(res)`: when `res` is `Ok(n)`, returns `n` when `res` is `Error(m)`, raise an exception
+
+## Examples
+
+```rescript
+Belt.Result.Ok(42)
+->Belt.Result.getOrThrow
+->assertEqual(42)
+
+
+switch Belt.Result.getOrThrow(Belt.Result.Error("Invalid data")) { // raise a exception
+| exception _ => assert(true)
+| _ => assert(false)
+}
+```
+*/
+let getOrThrow: t<'a, 'b> => 'a
+
 @deprecated("Use `mapWithDefault` instead")
 let mapWithDefaultU: (t<'a, 'c>, 'b, 'a => 'b) => 'b
 /**