Merge branch 'develop'

index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 
-require('./src/result._init.c');
 require('./src/result.and.c');
 require('./src/result.andThen.c');
 require('./src/result.expect.c');
@@ -20,7 +19,11 @@ require('./src/result.or.c');
 require('./src/result.orElse.c');
 require('./src/result.registerGlobals.c');
 require('./src/result.unwrap.c');
+require('./src/result.unwrapAnd.c');
+require('./src/result.unwrapAndThen.c');
 require('./src/result.unwrapErr.c');
+require('./src/result.unwrapOr.c');
+require('./src/result.unwrapOrElse.c');
 
 
 module.exports = require('./interface/result.h');

interface/result-sym.h.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = {
+    isOk: Symbol(),
+    value: Symbol(),
+};

interface/result.h.js

@@ -38,6 +38,15 @@
  * @returns {*}
  */
 
+/**
+ * This Callback is used to produce a final Value
+ *
+ * @callback ValueEmitter
+ * @param {*} val
+ *   `val` will contain the result of {Result}.
+ * @returns {*}
+ */
+
 /**
  * This Callback is used as a return-handler
  *
@@ -60,17 +69,6 @@
  * @type {Result}
  */
 module.exports = class Result {
-
-    /**
-     * Create new Result from either a value or an error
-     * Leave the one you don't need undefined
-     * You have to pass something to exactly one of the two
-     * 
-     * @param {*} val
-     * @param {*} err
-     */
-    constructor (val, err) { this._init(val, err); };
-
     /**
      * Create success Result with a return value.
      *
@@ -141,40 +139,36 @@ module.exports = class Result {
     iter() { throw new Error ('Not Implemented: Result.iter'); };
 
     /**
-     * Returns `val` if the result is Ok, otherwise returns the Err value of itself.
+     * Returns `Ok(val)` if the result is Ok, otherwise returns `Err(err)` of itself.
      *
      * @param {*} val
-     * @returns {*}
+     * @returns {Result}
      */
     and(val) { throw new Error ('Not Implemented: Result.and'); };
 
     /**
-     * Calls `resultEmitter` if the result is Ok, otherwise returns the Err value of itself.
+     * Calls `resultEmitter` if the result is Ok, otherwise returns `Err(err)` value of itself.
      * This function can be used for control flow based on Result values.
      *
      * @param {ResultEmitter} resultEmitter
-     * @returns {*}
+     * @returns {Result}
      */
     andThen(resultEmitter) { throw new Error ('Not Implemented: Result.andThen'); };
 
     /**
-     * Returns `val` if the result is Err, otherwise returns the Ok value of itself.
-     * Since there are no strict types in JS, this method and unwrapOr are identical.
+     * Returns `Ok(val)` if the result is Err, otherwise returns `Ok(ok)` of itself.
      *
-     * @alias unwrapOr
      * @param {*} val
-     * @returns {*}
+     * @returns {Result}
      */
     or(val) { throw new Error ('Not Implemented: Result.or'); };
 
     /**
-     * Calls `resultEmitter` if the result is Err, otherwise returns the Ok value of itself.
+     * Calls `resultEmitter` if the result is Err, otherwise returns the `Ok(ok)` value of itself.
      * This function can be used for control flow based on result values.
-     * Since there are no strict types in JS, this method and unwrapOrElse are identical.
      *
-     * @alias unwrapOrElse
      * @param {ResultEmitter} resultEmitter
-     * @returns {*}
+     * @returns {Result}
      */
     orElse(resultEmitter) { throw new Error ('Not Implemented: Result.orElse'); };
 
@@ -186,6 +180,22 @@ module.exports = class Result {
      */
     unwrap() { throw new Error ('Not Implemented: Result.unwrap'); };
 
+    /**
+     * Unwraps a result, yielding the content of optb. Else it throws.
+     *
+     * @param {*} optb
+     * @return {*}
+     */
+    unwrapAnd(optb) { throw new Error ('Not Implemented: Result.unwrapAnd'); };
+
+    /**
+     * Unwraps a result, calling valEmitter with its value. If the value is an Err then it throws.
+     *
+     * @param {ValueEmitter} valEmitter
+     * @return {*}
+     */
+    unwrapAndThen(valEmitter) { throw new Error ('Not Implemented: Result.unwrapAndThen'); };
+
     /**
      * Unwraps a result, yielding the content of an Err.
      * 
@@ -194,6 +204,22 @@ module.exports = class Result {
      */
     unwrapErr() { throw new Error ('Not Implemented: Result.unwrapErr'); };
 
+    /**
+     * Unwraps a result, yielding the content of an Ok. Else it returns optb.
+     *
+     * @param {*} optb
+     * @return {*}
+     */
+    unwrapOr(optb) { throw new Error ('Not Implemented: Result.unwrapOr'); };
+
+    /**
+     * Unwraps a result, yielding the content of an Ok. If the value is an Err then it calls valEmitter with its value.
+     *
+     * @param {ValueEmitter} valEmitter
+     * @return {*}
+     */
+    unwrapOrElse(valEmitter) { throw new Error ('Not Implemented: Result.unwrapOrElse'); };
+
     /**
      * Unwraps a result, yielding the content of an Ok.
      *

package.json

@@ -1,6 +1,6 @@
 {
   "name": "result-js",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "description": "Rusty Monad Results for JS",
   "author": {
     "email": "me@marco-alka.de",

src/result.and.c.js

@@ -1,6 +1,13 @@
 'use strict';
 
-require('../interface/result.h').prototype.and = function ($val) {
+const H = require('../interface/result.h').prototype;
+const sym = require('../interface/result-sym.h');
 
-    return this.isOk() ? $val : this._err;
+
+H.and = function ($val) {
+    if (this[sym.isOk]) {
+        this[sym.value] = $val;
+    }
+
+    return this;
 };

src/result.andThen.c.js

@@ -1,6 +1,13 @@
 'use strict';
 
-require('../interface/result.h').prototype.andThen = function ($resultEmitter) {
+const H = require('../interface/result.h').prototype;
+const sym = require('../interface/result-sym.h');
 
-    return this.isOk() ? $resultEmitter(this._val) : this._err;
+
+H.andThen = function ($resultEmitter) {
+    if (this[sym.isOk]) {
+        this[sym.value] = $resultEmitter(this[sym.value]);
+    }
+
+    return this;
 };

src/result.expect.c.js

@@ -1,10 +1,13 @@
 'use strict';
 
-require('../interface/result.h').prototype.expect = function ($msg) {
+const sym = require('../interface/result-sym.h');
 
-    return this.orElse(() => {
 
+require('../interface/result.h').prototype.expect = function ($msg) {
+    if (!this[sym.isOk]) {
         const msg = typeof $msg === 'string' ? $msg : 'ERROR: $msg is not a string. Also -> ';
-        throw new Error(`${msg}: ${this._err.toString()}`);
-    });
+        throw new Error(`${msg}: ${this[sym.value].toString()}`);
+    }
+
+    return this[sym.value];
 };

src/result.expectErr.c.js

@@ -1,12 +1,13 @@
 'use strict';
 
-require('../interface/result.h').prototype.expectErr = function ($msg) {
+const sym = require('../interface/result-sym.h');
 
-    if (this.isErr()) {
 
-        return this._err;
+require('../interface/result.h').prototype.expectErr = function ($msg) {
+    if (!this[sym.isOk]) {
+        return this[sym.value];
     }
 
     const msg = typeof $msg === 'string' ? $msg : 'ERROR: $msg is not a string. Also -> ';
-    throw new Error(`${msg}: ${this._ok.toString()}`);
+    throw new Error(`${msg}: ${this[sym.value].toString()}`);
 };

src/result.fromError.c.js

@@ -1,9 +1,14 @@
 'use strict';
 
-const h = require('../interface/result.h');
+const H = require('../interface/result.h');
+const sym = require('../interface/result-sym.h');
 
 
-h.fromError = function ($err) {
+H.fromError = function ($err) {
+    const result = new H();
 
-    return new h(undefined, $err);
+    result[sym.isOk] = false;
+    result[sym.value] = $err;
+
+    return result;
 };

src/result.fromSuccess.c.js

@@ -1,9 +1,14 @@
 'use strict';
 
-const h = require('../interface/result.h');
+const H = require('../interface/result.h');
+const sym = require('../interface/result-sym.h');
 
 
-h.fromSuccess = function ($val) {
+H.fromSuccess = function ($val) {
+    const result = new H();
 
-    return new h($val);
+    result[sym.isOk] = true;
+    result[sym.value] = $val;
+
+    return result;
 };

src/result.fromTry.c.js

@@ -1,16 +1,20 @@
 'use strict';
 
-const h = require('../interface/result.h');
+const H = require('../interface/result.h');
+const sym = require('../interface/result-sym.h');
 
 
-h.fromTry = function ($fun) {
+H.fromTry = function ($fun) {
+    const result = new H();
 
     try {
-
-        return h.fromSuccess($fun());
+        result[sym.value] = $fun();
+        result[sym.isOk] = true;
     }
     catch ($err) {
-
-        return h.fromError($err);
+        result[sym.value] = $err;
+        result[sym.isOk] = false;
     }
+
+    return result;
 };

src/result.isErr.c.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../interface/result.h').prototype.isErr = function () {
+const sym = require('../interface/result-sym.h');
+
 
-    return this._err !== null;
+require('../interface/result.h').prototype.isErr = function () {
+    return !this[sym.isOk];
 };

src/result.isOk.c.js

@@ -1,6 +1,8 @@
 'use strict';
 
-require('../interface/result.h').prototype.isOk = function () {
+const sym = require('../interface/result-sym.h');
+
 
-    return this._err === null;
+require('../interface/result.h').prototype.isOk = function () {
+    return !!this[sym.isOk];
 };

src/result.iter.c.js

@@ -1,18 +1,16 @@
 'use strict';
 
 const hProto = require('../interface/result.h').prototype;
+const sym = require('../interface/result-sym.h');
 
 
 hProto.iter = function () {
-
     const self = this;
-    return {
 
+    return {
         [Symbol.iterator]: function* () {
-
-            if (self.isOk()) {
-
-                yield self._val;
+            if (self[sym.isOk]) {
+                yield self[sym.value];
             }
         },
     };