Merge remote-tracking branch 'upstream/main' into Object-docs

Author: jmagaram

src/Core__Object.res

@@ -57,8 +57,7 @@ y->Object.get("fruit") // Some("banana")
 @val
 external create: {..} => {..} = "Object.create"
 
-@val
-external createWithProperties: ({..}, {..}) => {..} = "Object.create"
+@val external createWithProperties: ({..}, {..}) => {..} = "Object.create"
 @val external createWithNull: (@as(json`null`) _, unit) => {..} = "Object.create"
 @val external createWithNullAndProperties: (@as(json`null`) _, {..}) => {..} = "Object.create"
 
@@ -80,15 +79,15 @@ Object.assign({"a": 1}, {"a": null}) // {"a": null}
 @val
 external assign: ({..}, {..}) => {..} = "Object.assign"
 
-@variadic
-@val
 /**
 `assignMany(target, sources)` copies enumerable own properties from each source to the target, overwriting properties with the same name. Later sources' properties overwrite earlier ones. It returns the modified target object. A deep clone is not created; properties are copied by reference.
 
 **Note:** ReScript provides [first-class support for immutable objects](https://rescript-lang.org/docs/manual/latest/object), including spreading one object into another. This is often more convenient than using `assign` or `assignMany`.  
 
 See [Object.assign on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) or [ECMAScript Language Specification](https://tc39.es/ecma262/multipage/fundamental-objects.html#sec-object.assign).
 */
+@variadic
+@val
 external assignMany: ({..}, array<{..}>) => {..} = "Object.assign"
 
 @val external copy: (@as(json`{}`) _, {..} as 'a) => 'a = "Object.assign"
@@ -123,6 +122,7 @@ x->Object.getSymbol(fruit) // Some("banana")
 */
 @get_index
 external getSymbol: ({..}, Core__Symbol.t) => option<'a> = ""
+
 @get_index external getSymbolUnsafe: ({..}, Core__Symbol.t) => 'a = ""
 
 /**

src/Core__Result.mjs

@@ -102,6 +102,13 @@ function cmp(a, b, f) {
   }
 }
 
+function forEach(r, f) {
+  if (r.TAG === /* Ok */0) {
+    return Curry._1(f, r._0);
+  }
+  
+}
+
 export {
   getExn ,
   mapWithDefault ,
@@ -112,5 +119,6 @@ export {
   isError ,
   eq ,
   cmp ,
+  forEach ,
 }
 /* No side effect */

src/Core__Result.res

@@ -91,3 +91,9 @@ let cmpU = (a, b, f) =>
   }
 
 let cmp = (a, b, f) => cmpU(a, b, (. x, y) => f(x, y))
+
+let forEach = (r, f) =>
+  switch r {
+  | Ok(ok) => f(ok)
+  | Error(_) => ()
+  }

src/Core__Result.resi

@@ -197,3 +197,15 @@ let eq: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => bool) => bool
   ```
 */
 let cmp: (t<'a, 'c>, t<'b, 'd>, ('a, 'b) => int) => int
+
+/**
+`forEach(res, f)` runs the provided function `f` on the `Ok` value. If `res` is `Error`, nothing happens. 
+
+## Examples
+
+```rescript
+Result.forEach(Ok(3), Console.log) // Logs "3", returns ()
+Result.forEach(Error("x"), Console.log) // Does nothing, returns ()
+```
+*/
+let forEach: (t<'a, 'b>, 'a => unit) => unit

test/ObjectTests.res

@@ -177,4 +177,3 @@ Test.run(
   eq,
   None,
 )
-

test/ResultTests.mjs

@@ -0,0 +1,60 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Test from "./Test.mjs";
+import * as Caml_obj from "rescript/lib/es6/caml_obj.js";
+import * as Core__Result from "../src/Core__Result.mjs";
+
+var eq = Caml_obj.equal;
+
+function forEachIfOkCallFunction(param) {
+  var called = {
+    contents: []
+  };
+  Core__Result.forEach({
+        TAG: /* Ok */0,
+        _0: 3
+      }, (function (i) {
+          called.contents.push(i);
+        }));
+  Test.run([
+        [
+          "ResultTests.res",
+          12,
+          22,
+          72
+        ],
+        "forEach: if ok, call function with ok value once"
+      ], called.contents, eq, [3]);
+}
+
+forEachIfOkCallFunction(undefined);
+
+function forEachIfErrorDoNotCallFunction(param) {
+  var called = {
+    contents: []
+  };
+  Core__Result.forEach({
+        TAG: /* Error */1,
+        _0: 3
+      }, (function (i) {
+          called.contents.push(i);
+        }));
+  Test.run([
+        [
+          "ResultTests.res",
+          19,
+          22,
+          63
+        ],
+        "forEach: if error, do not call function"
+      ], called.contents, eq, []);
+}
+
+forEachIfErrorDoNotCallFunction(undefined);
+
+export {
+  eq ,
+  forEachIfOkCallFunction ,
+  forEachIfErrorDoNotCallFunction ,
+}
+/*  Not a pure module */

test/ResultTests.res

@@ -0,0 +1,21 @@
+open RescriptCore
+
+let eq = (a, b) => a == b
+
+// =======
+// forEach
+// =======
+
+let forEachIfOkCallFunction = () => {
+  let called = ref([])
+  Ok(3)->Result.forEach(i => called.contents->Array.push(i))
+  Test.run(__POS_OF__("forEach: if ok, call function with ok value once"), called.contents, eq, [3])
+}
+forEachIfOkCallFunction()
+
+let forEachIfErrorDoNotCallFunction = () => {
+  let called = ref([])
+  Error(3)->Result.forEach(i => called.contents->Array.push(i))
+  Test.run(__POS_OF__("forEach: if error, do not call function"), called.contents, eq, [])
+}
+forEachIfErrorDoNotCallFunction()

test/TestSuite.mjs

@@ -6,6 +6,7 @@ import * as ArrayTests from "./ArrayTests.mjs";
 import * as ErrorTests from "./ErrorTests.mjs";
 import * as ObjectTests from "./ObjectTests.mjs";
 import * as PromiseTest from "./PromiseTest.mjs";
+import * as ResultTests from "./ResultTests.mjs";
 
 var bign = TestTests.bign;
 
@@ -29,6 +30,10 @@ var panicTest = ErrorTests.panicTest;
 
 var $$catch = IntTests.$$catch;
 
+var forEachIfOkCallFunction = ResultTests.forEachIfOkCallFunction;
+
+var forEachIfErrorDoNotCallFunction = ResultTests.forEachIfErrorDoNotCallFunction;
+
 var eq = ObjectTests.eq;
 
 var nums = ObjectTests.nums;
@@ -57,6 +62,8 @@ export {
   Concurrently ,
   panicTest ,
   $$catch ,
+  forEachIfOkCallFunction ,
+  forEachIfErrorDoNotCallFunction ,
   eq ,
   nums ,
   d ,

test/TestSuite.res

@@ -3,4 +3,5 @@ include PromiseTest
 include ErrorTests
 include ArrayTests
 include IntTests
+include ResultTests
 include ObjectTests