retuple 1.0.0-next.1 → 1.0.0-next.3

package/dist/index.cjs

@@ -12,13 +12,20 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _ResultAsync_inner;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Result = exports.RetupleThrownValueError = exports.RetupleExpectFailed = exports.RetupleUnwrapErrFailed = exports.RetupleUnwrapFailed = void 0;
+exports.RetupleInvalidResultError = exports.RetupleThrownValueError = exports.RetupleExpectFailed = exports.RetupleUnwrapErrFailed = exports.RetupleUnwrapFailed = void 0;
+exports.Result = Result;
 exports.Ok = Ok;
 exports.Err = Err;
-exports.from = from;
+exports.nonNullable = nonNullable;
+exports.truthy = truthy;
 exports.safe = safe;
 exports.safeAsync = safeAsync;
 exports.safePromise = safePromise;
+/**
+ * ## Retuple Unwrap Failed
+ *
+ * An error which occurs when calling `$unwrap` on `Err`.
+ */
 class RetupleUnwrapFailed extends Error {
     constructor(value, msg = "Unwrap failed") {
         super(msg, value instanceof Error ? { cause: value } : undefined);
@@ -26,6 +33,11 @@ class RetupleUnwrapFailed extends Error {
     }
 }
 exports.RetupleUnwrapFailed = RetupleUnwrapFailed;
+/**
+ * ## Retuple Unwrap Err Failed
+ *
+ * An error which occurs when calling `$unwrapErr` on `Ok`.
+ */
 class RetupleUnwrapErrFailed extends Error {
     constructor(value, msg = "Unwrap error failed") {
         super(msg);
@@ -33,6 +45,12 @@ class RetupleUnwrapErrFailed extends Error {
     }
 }
 exports.RetupleUnwrapErrFailed = RetupleUnwrapErrFailed;
+/**
+ * ## Retuple Expect Failed
+ *
+ * An error which occurs when calling `$expect` on `Err`, and when the value
+ * contained in the `Err` is not an instance of `Error`.
+ */
 class RetupleExpectFailed extends Error {
     constructor(value) {
         super("Expect failed");
@@ -40,6 +58,13 @@ class RetupleExpectFailed extends Error {
     }
 }
 exports.RetupleExpectFailed = RetupleExpectFailed;
+/**
+ * ## Retuple Thrown Value Error
+ *
+ * An error constructed when a safe function call throws or rejects, when the
+ * thrown error or rejected value is not an instance of `Error`, and when no
+ * map error function is provided.
+ */
 class RetupleThrownValueError extends Error {
     constructor(value) {
         super("Caught value was not an instance of Error");
@@ -47,50 +72,76 @@ class RetupleThrownValueError extends Error {
     }
 }
 exports.RetupleThrownValueError = RetupleThrownValueError;
+/**
+ * ## Retuple Invalid Result Error
+ *
+ * An error constructed when a safe function call throws or rejects, when the
+ * thrown error or rejected value is not an instance of `Error`, and when no
+ * map error function is provided.
+ */
+class RetupleInvalidResultError extends Error {
+    constructor(value) {
+        super("Constructing a Result from tuple failed, at least one of the values at index 0 or 1 should be undefined");
+        this.value = value;
+    }
+}
+exports.RetupleInvalidResultError = RetupleInvalidResultError;
 /**
  * ## Result
  *
  * @TODO
  */
-exports.Result = {
-    Ok,
-    Err,
-    from,
-    safe,
-    safeAsync,
-    safePromise,
-};
-exports.default = exports.Result;
+function Result(resultLike) {
+    const [err, ok] = resultLike;
+    if (err === null || err === undefined) {
+        return new ResultOk(ok);
+    }
+    if (ok === null || ok === undefined) {
+        return new ResultErr(err);
+    }
+    throw new RetupleInvalidResultError(resultLike);
+}
+Result.Ok = Ok;
+Result.Err = Err;
+Result.nonNullable = nonNullable;
+Result.truthy = truthy;
+Result.safe = safe;
+Result.safeAsync = safeAsync;
+Result.safePromise = safePromise;
+Object.freeze(Result);
 function Ok(val) {
     return new ResultOk(val);
 }
 function Err(err) {
     return new ResultErr(err);
 }
-function from(value, error) {
-    if (value) {
+function nonNullable(value, error = mapTrue) {
+    if (value !== null && value !== undefined) {
         return new ResultOk(value);
     }
-    if (error) {
-        return new ResultErr(error());
+    return new ResultErr(error());
+}
+function truthy(value, error = mapTrue) {
+    if (value) {
+        return new ResultOk(value);
     }
-    return new ResultErr(true);
+    return new ResultErr(error());
 }
 function safe(f, mapError = ensureError) {
     try {
-        return Ok(f());
+        return new ResultOk(f());
     }
     catch (err) {
-        return Err(mapError(err));
+        return new ResultErr(mapError(err));
     }
 }
 function safeAsync(f, mapError = ensureError) {
     return new ResultAsync((async () => {
         try {
-            return Ok(await f());
+            return new ResultOk(await f());
         }
         catch (err) {
-            return Err(await mapError(err));
+            return new ResultErr(await mapError(err));
         }
     })());
 }
@@ -108,6 +159,12 @@ class ResultOk extends Array {
         this[0] = undefined;
         this[1] = value;
     }
+    toJSON() {
+        return this[1];
+    }
+    $toNativeTuple() {
+        return [undefined, this[1]];
+    }
     $value() {
         return this[1];
     }
@@ -115,7 +172,7 @@ class ResultOk extends Array {
         return true;
     }
     $isOkAnd(f) {
-        return f(this[1]);
+        return !!f(this[1]);
     }
     $isErr() {
         return false;
@@ -150,6 +207,12 @@ class ResultOk extends Array {
     $mapOrElse(_def, f) {
         return new ResultOk(f(this[1]));
     }
+    $assertOr(def, condition = isTruthy) {
+        return condition(this[1]) ? this : def;
+    }
+    $assertOrElse(def, condition = isTruthy) {
+        return condition(this[1]) ? this : def();
+    }
     $or() {
         return this;
     }
@@ -209,6 +272,12 @@ class ResultErr extends Array {
         this[0] = err;
         this[1] = undefined;
     }
+    toJSON() {
+        return null;
+    }
+    $toNativeTuple() {
+        return [this[0], undefined];
+    }
     $value() {
         return this[0];
     }
@@ -222,7 +291,7 @@ class ResultErr extends Array {
         return true;
     }
     $isErrAnd(f) {
-        return f(this[0]);
+        return !!f(this[0]);
     }
     $expect() {
         if (this[0] instanceof Error) {
@@ -254,6 +323,12 @@ class ResultErr extends Array {
     $mapOrElse(def) {
         return new ResultOk(def(this[0]));
     }
+    $assertOr() {
+        return this;
+    }
+    $assertOrElse() {
+        return this;
+    }
     $or(or) {
         return or;
     }
@@ -391,6 +466,22 @@ class ResultAsync {
                 : new ResultOk(def(res[0]));
         }));
     }
+    $assertOr(def, condition = isTruthy) {
+        return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
+            if (res instanceof ResultErr || condition(res[1])) {
+                return res;
+            }
+            return await def;
+        }));
+    }
+    $assertOrElse(def, condition = isTruthy) {
+        return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
+            if (res instanceof ResultErr || condition(res[1])) {
+                return res;
+            }
+            return await def();
+        }));
+    }
     /**
      * @TODO
      */
@@ -407,9 +498,6 @@ class ResultAsync {
             return res instanceof ResultErr ? await f(res[0]) : res;
         }));
     }
-    /**
-     * @TODO
-     */
     $orSafe(f, mapError = ensureError) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
             if (res instanceof ResultOk) {
@@ -453,9 +541,6 @@ class ResultAsync {
             return res;
         }));
     }
-    /**
-     * @TODO
-     */
     $andSafe(f, mapError = ensureError) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
             if (res instanceof ResultErr) {
@@ -514,18 +599,9 @@ function ensureError(err) {
     }
     return new RetupleThrownValueError(err);
 }
-Object.freeze(exports.Result);
-Object.freeze(ResultOk);
-Object.freeze(ResultErr);
-Object.freeze(ResultAsync);
-Object.freeze(RetupleUnwrapFailed);
-Object.freeze(RetupleUnwrapErrFailed);
-Object.freeze(RetupleExpectFailed);
-Object.freeze(RetupleThrownValueError);
-Object.freeze(ResultOk.prototype);
-Object.freeze(ResultErr.prototype);
-Object.freeze(ResultAsync.prototype);
-Object.freeze(RetupleUnwrapFailed.prototype);
-Object.freeze(RetupleUnwrapErrFailed.prototype);
-Object.freeze(RetupleExpectFailed.prototype);
-Object.freeze(RetupleThrownValueError.prototype);
+function mapTrue() {
+    return true;
+}
+function isTruthy(val) {
+    return !!val;
+}