Rename Result.getExn

Author: DZakh

lib/es6/Stdlib_Result.js

@@ -1,7 +1,7 @@
 
 
 
-function getExn(x) {
+function getOrThrow(x) {
   if (x.TAG === "Ok") {
     return x._0;
   }
@@ -342,12 +342,15 @@ function all6(param) {
   }
 }
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 let getWithDefault = getOr;
 
 export {
   getExn,
+  getOrThrow,
   mapOr,
   mapWithDefault,
   map,

lib/js/Stdlib_Result.js

@@ -1,7 +1,7 @@
 'use strict';
 
 
-function getExn(x) {
+function getOrThrow(x) {
   if (x.TAG === "Ok") {
     return x._0;
   }
@@ -342,11 +342,14 @@ function all6(param) {
   }
 }
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 let getWithDefault = getOr;
 
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.mapOr = mapOr;
 exports.mapWithDefault = mapWithDefault;
 exports.map = map;

runtime/Stdlib_Result.res

@@ -23,12 +23,14 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
 type t<'res, 'err> = result<'res, 'err> = Ok('res) | Error('err)
 
-let getExn = x =>
+let getOrThrow = x =>
   switch x {
   | Ok(x) => x
   | Error(_) => throw(Not_found)
   }
 
+let getExn = getOrThrow
+
 let mapOr = (opt, default, f) =>
   switch opt {
   | Ok(x) => f(x)

runtime/Stdlib_Result.resi

@@ -59,8 +59,23 @@ type t<'res, 'err> = result<'res, 'err> = Ok('res) | Error('err)
   }
   ```
 */
+@deprecated("Use 'getOrThrow' instead")
 let getExn: result<'a, 'b> => 'a
 
+/**
+  `getOrThrow(res)`: when `res` is `Ok(n)`, returns `n` when `res` is `Error(m)`, raise an exception
+
+  ```res example
+  Result.getOrThrow(Result.Ok(42)) == 42
+
+  switch Result.getOrThrow(Error("Invalid data")) {
+  | exception Not_found => assert(true)
+  | _ => assert(false)
+  }
+  ```
+*/
+let getOrThrow: result<'a, 'b> => 'a
+
 /**
 `mapOr(res, default, f)`: When res is `Ok(n)`, returns `f(n)`, otherwise `default`.