retuple 1.0.0-next.5 → 1.0.0-next.7

package/dist/index.js

@@ -35,7 +35,7 @@ export class RetupleUnwrapErrFailed extends Error {
 /**
  * ## Retuple Expect Failed
  *
- * An error which occurs when calling `$expect` on `Err`, and when the value
+ * An error which occurs when calling `$expect` on `Err`, when the value
  * contained in the `Err` is not an instance of `Error`.
  */
 export class RetupleExpectFailed extends Error {
@@ -44,6 +44,18 @@ export class RetupleExpectFailed extends Error {
         this.value = value;
     }
 }
+/**
+ * ## Retuple Expect Failed
+ *
+ * An error which occurs when calling `$flatten` on `Ok`, when the value
+ * contained in the `Ok` is not an `Ok` or `Err`.
+ */
+export class RetupleFlattenFailed extends Error {
+    constructor(value) {
+        super("Flatten Result failed, the contained value was not a Result");
+        this.value = value;
+    }
+}
 /**
  * ## Retuple Thrown Value Error
  *
@@ -60,13 +72,26 @@ export class RetupleThrownValueError extends Error {
 /**
  * ## Retuple Invalid Result Error
  *
- * 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`.
+ * This error is thrown when attempting to construct a `Result` from a 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 native tuple failed, at least one of the values at index 0 or 1 should be null or 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;
+    }
+}
+/**
+ * ## Retuple Array Method Unavailable Error
+ *
+ * This error is thrown when calling a built-in array method from a `Result`.
+ */
+export class RetupleArrayMethodUnavailableError extends Error {
+    constructor(value, method) {
+        super(`Built in array method '${method}' should not be called directly from ` +
+            "a Result, convert the Result to a tuple first");
         this.value = value;
     }
 }
@@ -87,11 +112,11 @@ export function Result(resultLike) {
 }
 Result.Ok = Ok;
 Result.Err = Err;
-Result.nonNullable = nonNullable;
-Result.truthy = truthy;
-Result.safe = safe;
-Result.safeAsync = safeAsync;
-Result.safePromise = safePromise;
+Result.$nonNullable = nonNullable;
+Result.$truthy = truthy;
+Result.$safe = safe;
+Result.$safeAsync = safeAsync;
+Result.$safePromise = safePromise;
 Object.freeze(Result);
 export function Ok(val) {
     return new ResultOk(val);
@@ -101,31 +126,31 @@ export function Err(err) {
 }
 export function nonNullable(value, error = mapTrue) {
     if (value !== null && value !== undefined) {
-        return new ResultOk(value);
+        return Ok(value);
     }
-    return new ResultErr(error());
+    return Err(error());
 }
 export function truthy(value, error = mapTrue) {
     if (value) {
-        return new ResultOk(value);
+        return Ok(value);
     }
-    return new ResultErr(error());
+    return Err(error());
 }
 export function safe(f, mapError = ensureError) {
     try {
-        return new ResultOk(f());
+        return Ok(f());
     }
     catch (err) {
-        return new ResultErr(mapError(err));
+        return Err(mapError(err));
     }
 }
 export function safeAsync(f, mapError = ensureError) {
     return new ResultAsync((async () => {
         try {
-            return new ResultOk(await f());
+            return Ok(await f());
         }
         catch (err) {
-            return new ResultErr(await mapError(err));
+            return Err(await mapError(err));
         }
     })());
 }
@@ -133,11 +158,437 @@ export function safePromise(promise, mapError = ensureError) {
     return new ResultAsync(promise.then((Ok), async (err) => Err(await mapError(err))));
 }
 /**
- * ## Ok
+ * ## RetupleArray
  *
- * @TODO
+ * Using built-in array methods on a `Result` is probably a mistake. This class
+ * makes the built-in methods throw `RetupleArrayMethodUnavailableError`.
  */
-class ResultOk extends Array {
+class RetupleArray extends Array {
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    at() {
+        throw new RetupleArrayMethodUnavailableError(this, "at");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    concat() {
+        throw new RetupleArrayMethodUnavailableError(this, "concat");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    copyWithin() {
+        throw new RetupleArrayMethodUnavailableError(this, "copyWithin");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    entries() {
+        throw new RetupleArrayMethodUnavailableError(this, "entries");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    every() {
+        throw new RetupleArrayMethodUnavailableError(this, "every");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    fill() {
+        throw new RetupleArrayMethodUnavailableError(this, "fill");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    filter() {
+        throw new RetupleArrayMethodUnavailableError(this, "filter");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    find() {
+        throw new RetupleArrayMethodUnavailableError(this, "find");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    findIndex() {
+        throw new RetupleArrayMethodUnavailableError(this, "findIndex");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    findLast() {
+        throw new RetupleArrayMethodUnavailableError(this, "findLast");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    findLastIndex() {
+        throw new RetupleArrayMethodUnavailableError(this, "findLastIndex");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    flat() {
+        throw new RetupleArrayMethodUnavailableError(this, "flat");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    flatMap() {
+        throw new RetupleArrayMethodUnavailableError(this, "flatMap");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    forEach() {
+        throw new RetupleArrayMethodUnavailableError(this, "forEach");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    includes() {
+        throw new RetupleArrayMethodUnavailableError(this, "includes");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    indexOf() {
+        throw new RetupleArrayMethodUnavailableError(this, "indexOf");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    join() {
+        throw new RetupleArrayMethodUnavailableError(this, "join");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    keys() {
+        throw new RetupleArrayMethodUnavailableError(this, "keys");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    lastIndexOf() {
+        throw new RetupleArrayMethodUnavailableError(this, "lastIndexOf");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    map() {
+        throw new RetupleArrayMethodUnavailableError(this, "map");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    pop() {
+        throw new RetupleArrayMethodUnavailableError(this, "pop");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    push() {
+        throw new RetupleArrayMethodUnavailableError(this, "push");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    reduce() {
+        throw new RetupleArrayMethodUnavailableError(this, "reduce");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    reduceRight() {
+        throw new RetupleArrayMethodUnavailableError(this, "reduceRight");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    reverse() {
+        throw new RetupleArrayMethodUnavailableError(this, "reverse");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    shift() {
+        throw new RetupleArrayMethodUnavailableError(this, "shift");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    slice() {
+        throw new RetupleArrayMethodUnavailableError(this, "slice");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    some() {
+        throw new RetupleArrayMethodUnavailableError(this, "some");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    sort() {
+        throw new RetupleArrayMethodUnavailableError(this, "sort");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    splice() {
+        throw new RetupleArrayMethodUnavailableError(this, "splice");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    toString() {
+        throw new RetupleArrayMethodUnavailableError(this, "toString");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    toLocaleString() {
+        throw new RetupleArrayMethodUnavailableError(this, "toLocaleString");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    toReversed() {
+        throw new RetupleArrayMethodUnavailableError(this, "toReversed");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    toSorted() {
+        throw new RetupleArrayMethodUnavailableError(this, "toSorted");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    toSpliced() {
+        throw new RetupleArrayMethodUnavailableError(this, "toSpliced");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    unshift() {
+        throw new RetupleArrayMethodUnavailableError(this, "unshift");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    values() {
+        throw new RetupleArrayMethodUnavailableError(this, "values");
+    }
+    /**
+     * ## Method not available
+     *
+     * Built-in array methods not available on `Result` types, convert the result
+     * to a tuple using `$tuple()` first.
+     *
+     * @deprecated
+     */
+    with() {
+        throw new RetupleArrayMethodUnavailableError(this, "with");
+    }
+}
+/**
+ * ## ResultOk
+ *
+ * This is the `Ok` variant of a `Result`, used internally and not exported.
+ */
+class ResultOk extends RetupleArray {
     constructor(value) {
         super(2);
         this[0] = undefined;
@@ -146,15 +597,6 @@ class ResultOk extends Array {
     toJSON() {
         return this[1];
     }
-    $toNativeTuple() {
-        return [undefined, this[1]];
-    }
-    $value() {
-        return this[1];
-    }
-    $ok() {
-        return this[1];
-    }
     $isOk() {
         return true;
     }
@@ -183,22 +625,22 @@ class ResultOk extends Array {
         return this[1];
     }
     $map(f) {
-        return new ResultOk(f(this[1]));
+        return Ok(f(this[1]));
     }
     $mapErr() {
         return this;
     }
     $mapOr(_def, f) {
-        return new ResultOk(f(this[1]));
+        return Ok(f(this[1]));
     }
     $mapOrElse(_def, f) {
-        return new ResultOk(f(this[1]));
+        return Ok(f(this[1]));
     }
     $assertOr(def, condition = isTruthy) {
         return condition(this[1]) ? this : def;
     }
     $assertOrElse(def, condition = isTruthy) {
-        return condition(this[1]) ? this : def();
+        return condition(this[1]) ? this : def(this[1]);
     }
     $or() {
         return this;
@@ -221,10 +663,10 @@ class ResultOk extends Array {
     }
     $andSafe(f, mapError = ensureError) {
         try {
-            return new ResultOk(f(this[1]));
+            return Ok(f(this[1]));
         }
         catch (err) {
-            return new ResultErr(mapError(err));
+            return Err(mapError(err));
         }
     }
     $peek(f) {
@@ -239,7 +681,11 @@ class ResultOk extends Array {
         return this;
     }
     $flatten() {
-        return this[1];
+        const inner = this[1];
+        if (inner instanceof ResultOk || inner instanceof ResultErr) {
+            return inner;
+        }
+        throw new RetupleFlattenFailed(this[1]);
     }
     $async() {
         return new ResultAsync(Promise.resolve(this));
@@ -247,13 +693,19 @@ class ResultOk extends Array {
     $promise() {
         return Promise.resolve(this);
     }
+    $tuple() {
+        return [undefined, this[1]];
+    }
+    *$iter() {
+        yield* this[1];
+    }
 }
 /**
- * ## Err
+ * ## ResultErr
  *
- * @TODO
+ * This is the `Err` variant of a `Result`, used internally and not exported.
  */
-class ResultErr extends Array {
+class ResultErr extends RetupleArray {
     constructor(err) {
         super(2);
         this[0] = err;
@@ -262,15 +714,6 @@ class ResultErr extends Array {
     toJSON() {
         return null;
     }
-    $toNativeTuple() {
-        return [this[0], undefined];
-    }
-    $value() {
-        return this[0];
-    }
-    $ok() {
-        undefined;
-    }
     $isOk() {
         return false;
     }
@@ -305,13 +748,13 @@ class ResultErr extends Array {
         return this;
     }
     $mapErr(f) {
-        return new ResultErr(f(this[0]));
+        return Err(f(this[0]));
     }
     $mapOr(def) {
-        return new ResultOk(def);
+        return Ok(def);
     }
     $mapOrElse(def) {
-        return new ResultOk(def(this[0]));
+        return Ok(def(this[0]));
     }
     $assertOr() {
         return this;
@@ -327,10 +770,10 @@ class ResultErr extends Array {
     }
     $orSafe(f, mapError = ensureError) {
         try {
-            return new ResultOk(f(this[0]));
+            return Ok(f(this[0]));
         }
         catch (err) {
-            return new ResultErr(mapError(err));
+            return Err(mapError(err));
         }
     }
     $and() {
@@ -365,6 +808,12 @@ class ResultErr extends Array {
     $promise() {
         return Promise.resolve(this);
     }
+    $tuple() {
+        return [this[0], undefined];
+    }
+    *$iter() {
+        return;
+    }
 }
 /**
  * ## ResultAsync
@@ -380,92 +829,71 @@ class ResultAsync {
         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
+     * The same as {@link Retuple.$expect|$expect}, except it returns a `Promise`.
      */
     async $expect() {
         return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$expect();
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$unwrap|$unwrap}, except it returns a `Promise`.
      */
     async $unwrap(msg) {
         return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$unwrap(msg);
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$unwrapErr|$unwrapErr}, except it returns
+     * a `Promise`.
      */
     async $unwrapErr(msg) {
         return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$unwrapErr(msg);
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$unwrapOr|$unwrapOr}, except it returns
+     * a `Promise`.
      */
     async $unwrapOr(def) {
         return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$unwrapOr(def);
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$unwrapOrElse|$unwrapOrElse}, except it returns
+     * a `Promise`.
      */
     async $unwrapOrElse(f) {
         const res = await __classPrivateFieldGet(this, _ResultAsync_inner, "f");
         return res instanceof ResultOk ? res[1] : f();
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$map|$map}, except it returns `ResultAsync`.
      */
     $map(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
-            return res instanceof ResultOk
-                ? new ResultOk(f(res[1]))
-                : res;
+            return res instanceof ResultOk ? Ok(f(res[1])) : res;
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$mapErr|$mapErr}, except it returns
+     * `ResultAsync`.
      */
     $mapErr(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
-            return res instanceof ResultErr
-                ? new ResultErr(f(res[0]))
-                : res;
+            return res instanceof ResultErr ? Err(f(res[0])) : res;
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$mapOr|$mapOr}, except it returns `ResultAsync`.
      */
     $mapOr(def, f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
-            return res instanceof ResultOk
-                ? new ResultOk(f(res[1]))
-                : new ResultOk(def);
+            return res instanceof ResultOk ? Ok(f(res[1])) : Ok(def);
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$mapOrElse|$mapOrElse}, except it returns
+     * `ResultAsync`.
      */
     $mapOrElse(def, f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
-            return res instanceof ResultOk
-                ? new ResultOk(f(res[1]))
-                : new ResultOk(def(res[0]));
+            return res instanceof ResultOk ? Ok(f(res[1])) : Ok(def(res[0]));
         }));
     }
     $assertOr(def, condition = isTruthy) {
@@ -481,23 +909,19 @@ class ResultAsync {
             if (res instanceof ResultErr || condition(res[1])) {
                 return res;
             }
-            return await def();
+            return await def(res[1]);
         }));
     }
-    /**
-     * @TODO
-     */
     $or(or) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
             return res instanceof ResultErr ? await or : res;
         }));
     }
-    /**
-     * @TODO
-     */
     $orElse(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
-            return res instanceof ResultErr ? await f(res[0]) : res;
+            return res instanceof ResultErr
+                ? await f(res[0])
+                : res;
         }));
     }
     $orSafe(f, mapError = ensureError) {
@@ -506,32 +930,23 @@ class ResultAsync {
                 return res;
             }
             try {
-                return new ResultOk(await f(res[0]));
+                return Ok(await f(res[0]));
             }
             catch (err) {
-                return new ResultErr(mapError(err));
+                return Err(mapError(err));
             }
         }));
     }
-    /**
-     * @TODO
-     */
     $and(and) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
             return res instanceof ResultOk ? await and : res;
         }));
     }
-    /**
-     * @TODO
-     */
     $andThen(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
             return res instanceof ResultOk ? await f(res[1]) : res;
         }));
     }
-    /**
-     * @TODO
-     */
     $andThrough(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
             if (res instanceof ResultOk) {
@@ -549,15 +964,18 @@ class ResultAsync {
                 return res;
             }
             try {
-                return new ResultOk(await f(res[1]));
+                return Ok(await f(res[1]));
             }
             catch (err) {
-                return new ResultErr(mapError(err));
+                return Err(mapError(err));
             }
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$peek|$peek}, except it:
+     *
+     * - awaits the peek function;
+     * - returns `ResultAsync`.
      */
     $peek(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
@@ -566,7 +984,10 @@ class ResultAsync {
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$tap|$tap}, except it:
+     *
+     * - awaits the tap function;
+     * - returns `ResultAsync`.
      */
     $tap(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
@@ -577,7 +998,10 @@ class ResultAsync {
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$tapErr|$tapErr}, except it:
+     *
+     * - awaits the tap error function;
+     * - returns `ResultAsync`.
      */
     $tapErr(f) {
         return new ResultAsync(__classPrivateFieldGet(this, _ResultAsync_inner, "f").then(async (res) => {
@@ -588,11 +1012,23 @@ class ResultAsync {
         }));
     }
     /**
-     * @TODO
+     * The same as {@link Retuple.$promise|$promise}.
      */
     $promise() {
         return Promise.resolve(this);
     }
+    /**
+     * The same as {@link Retuple.$tuple|$tuple}, except it returns a `Promise`.
+     */
+    async $tuple() {
+        return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$tuple();
+    }
+    /**
+     * The same as {@link Retuple.$tuple|$iter}, except it returns a `Promise`.
+     */
+    async $iter() {
+        return (await __classPrivateFieldGet(this, _ResultAsync_inner, "f")).$iter();
+    }
 }
 _ResultAsync_inner = new WeakMap();
 function ensureError(err) {