retuple 1.0.0-next.3 → 1.0.0-next.5

package/dist/index.cjs

@@ -75,13 +75,13 @@ 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.
+ * An error thrown when attempting to construct a `Result` from a native tuple,
+ * when neither index 0 or 1 are null or undefined. In this case, it is impossible
+ * to determine whether the result should be `Ok` or `Err`.
  */
 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");
+        super("Constructing a Result from native tuple failed, at least one of the values at index 0 or 1 should be null or undefined");
         this.value = value;
     }
 }
@@ -168,6 +168,9 @@ class ResultOk extends Array {
     $value() {
         return this[1];
     }
+    $ok() {
+        return this[1];
+    }
     $isOk() {
         return true;
     }
@@ -281,6 +284,9 @@ class ResultErr extends Array {
     $value() {
         return this[0];
     }
+    $ok() {
+        undefined;
+    }
     $isOk() {
         return false;
     }
@@ -389,12 +395,24 @@ class ResultAsync {
     then(onfulfilled, onrejected) {
         return __classPrivateFieldGet(this, _ResultAsync_inner, "f").then(onfulfilled, onrejected);
     }
+    /**
+     * @TODO
+     */
+    async $toNativeTuple() {
+        return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$toNativeTuple();
+    }
     /**
      * @TODO
      */
     async $value() {
         return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$value();
     }
+    /**
+     * @TODO
+     */
+    async $ok() {
+        return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$ok();
+    }
     /**
      * @TODO
      */

package/dist/index.d.cts

@@ -49,9 +49,9 @@ export declare class RetupleThrownValueError extends Error {
 /**
  * ## 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.
+ * An error thrown when attempting to construct a `Result` from a native tuple,
+ * when neither index 0 or 1 are null or undefined. In this case, it is impossible
+ * to determine whether the result should be `Ok` or `Err`.
  */
 export declare class RetupleInvalidResultError extends Error {
     value: unknown[];
@@ -125,10 +125,18 @@ declare class ResultAsync<T, E> {
     #private;
     constructor(inner: PromiseLike<Result<T, E>>);
     then<U = Result<T, E>, F = never>(onfulfilled?: ((value: Result<T, E>) => U | PromiseLike<U>) | null | undefined, onrejected?: ((reason: any) => F | PromiseLike<F>) | null | undefined): PromiseLike<U | F>;
+    /**
+     * @TODO
+     */
+    $toNativeTuple(this: ResultAsync<T, E>): Promise<OkTuple<T> | ErrTuple<E>>;
     /**
      * @TODO
      */
     $value(this: ResultAsync<T, E>): Promise<T | E>;
+    /**
+     * @TODO
+     */
+    $ok(this: ResultAsync<T, E>): Promise<T | undefined>;
     /**
      * @TODO
      */
@@ -238,6 +246,10 @@ interface Retuple<T, E> {
      * @TODO
      */
     $value(this: Result<T, E>): T | E;
+    /**
+     * @TODO
+     */
+    $ok(this: Result<T, E>): T | undefined;
     /**
      * @TODO
      */

package/dist/index.d.ts

@@ -49,9 +49,9 @@ export declare class RetupleThrownValueError extends Error {
 /**
  * ## 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.
+ * An error thrown when attempting to construct a `Result` from a native tuple,
+ * when neither index 0 or 1 are null or undefined. In this case, it is impossible
+ * to determine whether the result should be `Ok` or `Err`.
  */
 export declare class RetupleInvalidResultError extends Error {
     value: unknown[];
@@ -125,10 +125,18 @@ declare class ResultAsync<T, E> {
     #private;
     constructor(inner: PromiseLike<Result<T, E>>);
     then<U = Result<T, E>, F = never>(onfulfilled?: ((value: Result<T, E>) => U | PromiseLike<U>) | null | undefined, onrejected?: ((reason: any) => F | PromiseLike<F>) | null | undefined): PromiseLike<U | F>;
+    /**
+     * @TODO
+     */
+    $toNativeTuple(this: ResultAsync<T, E>): Promise<OkTuple<T> | ErrTuple<E>>;
     /**
      * @TODO
      */
     $value(this: ResultAsync<T, E>): Promise<T | E>;
+    /**
+     * @TODO
+     */
+    $ok(this: ResultAsync<T, E>): Promise<T | undefined>;
     /**
      * @TODO
      */
@@ -238,6 +246,10 @@ interface Retuple<T, E> {
      * @TODO
      */
     $value(this: Result<T, E>): T | E;
+    /**
+     * @TODO
+     */
+    $ok(this: Result<T, E>): T | undefined;
     /**
      * @TODO
      */

package/dist/index.js

@@ -60,13 +60,13 @@ export class RetupleThrownValueError extends Error {
 /**
  * ## 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.
+ * An error thrown when attempting to construct a `Result` from a native tuple,
+ * when neither index 0 or 1 are null or undefined. In this case, it is impossible
+ * to determine whether the result should be `Ok` or `Err`.
  */
 export 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");
+        super("Constructing a Result from native tuple failed, at least one of the values at index 0 or 1 should be null or undefined");
         this.value = value;
     }
 }
@@ -152,6 +152,9 @@ class ResultOk extends Array {
     $value() {
         return this[1];
     }
+    $ok() {
+        return this[1];
+    }
     $isOk() {
         return true;
     }
@@ -265,6 +268,9 @@ class ResultErr extends Array {
     $value() {
         return this[0];
     }
+    $ok() {
+        undefined;
+    }
     $isOk() {
         return false;
     }
@@ -373,12 +379,24 @@ class ResultAsync {
     then(onfulfilled, onrejected) {
         return __classPrivateFieldGet(this, _ResultAsync_inner, "f").then(onfulfilled, onrejected);
     }
+    /**
+     * @TODO
+     */
+    async $toNativeTuple() {
+        return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$toNativeTuple();
+    }
     /**
      * @TODO
      */
     async $value() {
         return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$value();
     }
+    /**
+     * @TODO
+     */
+    async $ok() {
+        return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$ok();
+    }
     /**
      * @TODO
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retuple",
-  "version": "1.0.0-next.3",
+  "version": "1.0.0-next.5",
   "scripts": {
     "test": "vitest",
     "lint": "eslint . --ext .ts -c eslint.config.mjs --fix",
@@ -13,11 +13,11 @@
   "module": "./dist/index.js",
   "zshy": "./src/index.ts",
   "keywords": [
-    "error",
-    "handling",
-    "safe",
     "result",
+    "safe",
     "throw",
+    "error",
+    "handling",
     "monad"
   ],
   "author": "Matthew Wilson",