Add Belt.Option.getOrThrow

Author: mediremi

CHANGELOG.md

@@ -58,6 +58,7 @@
   - `Belt.List.headExn` → `Belt.List.headOrThrow`
   - `Belt.MutableQueue.peekExn` → `Belt.MutableQueue.peekOrThrow`
   - `Belt.MutableQueue.popExn` → `Belt.MutableQueue.popOrThrow`
+  - `Belt.Option.getExn` → `Belt.Option.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

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

runtime/Belt_Option.res

@@ -34,12 +34,14 @@ let forEach = (opt, f) =>
   | None => ()
   }
 
-let getExn = x =>
+let getOrThrow = x =>
   switch x {
   | Some(x) => x
   | None => throw(Not_found)
   }
 
+let getExn = getOrThrow
+
 external getUnsafe: option<'a> => 'a = "%identity"
 
 let mapWithDefault = (opt, default, f) =>

runtime/Belt_Option.resi

@@ -89,8 +89,27 @@ switch Belt.Option.getExn(None) { // Raises an exception
 }
 ```
 */
+@deprecated("Use `getOrThrow` instead")
 let getExn: option<'a> => 'a
 
+/**
+Raises an Error in case `None` is provided. Use with care.
+
+## Examples
+
+```rescript
+Some(3)
+->Belt.Option.getOrThrow
+->assertEqual(3)
+
+switch Belt.Option.getOrThrow(None) { // Raises an exception
+| exception _ => assert(true)
+| _ => assert(false)
+}
+```
+*/
+let getOrThrow: option<'a> => 'a
+
 /**
 `getUnsafe(x)` returns `x`