safeTry should not require .safeUnwrap()

Author: dmmulroy

package-lock.json

@@ -11,6 +11,7 @@
   "scripts": {
     "local-ci": "npm run typecheck && npm run lint && npm run test && npm run format && npm run build",
     "test": "jest && npm run test-types",
+    "jest": "jest",
     "test-types": "tsc --noEmit -p ./tests/tsconfig.tests.json",
     "lint": "eslint ./src --ext .ts",
     "format": "prettier --write 'src/**/*.ts?(x)' && npm run lint -- --fix",
@@ -36,21 +37,22 @@
     "@babel/preset-typescript": "7.24.7",
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.7",
-    "@types/jest": "27.4.1",
+    "@jest/test-utils": "^0.0.0",
+    "@types/jest": "29.5.12",
     "@types/node": "^18.19.39",
     "@typescript-eslint/eslint-plugin": "4.28.1",
     "@typescript-eslint/parser": "4.28.1",
-    "babel-jest": "27.5.1",
+    "babel-jest": "29.7.0",
     "eslint": "7.30.0",
     "eslint-config-prettier": "7.1.0",
     "eslint-plugin-prettier": "3.4.0",
-    "jest": "27.5.1",
+    "jest": "29.7.0",
     "prettier": "2.2.1",
     "rollup": "^4.18.0",
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-typescript2": "^0.32.1",
     "testdouble": "3.20.2",
-    "ts-jest": "27.1.5",
+    "ts-jest": "29.2.5",
     "ts-toolbelt": "9.6.0",
     "typescript": "4.7.2"
   },

package.json

@@ -205,6 +205,18 @@ export class ResultAsync<T, E> implements PromiseLike<Result<T, E>> {
   ): PromiseLike<A | B> {
     return this._promise.then(successCallback, failureCallback)
   }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Err<never, E>, T> {
+    const result = await this._promise
+
+    if (result.isErr()) {
+      // @ts-expect-error -- This is structurally equivalent and safe
+      yield errAsync(result.error)
+    }
+
+    // @ts-expect-error -- This is structurally equivalent and safe
+    return result.value
+  }
 }
 
 export const okAsync = <T, E = never>(value: T): ResultAsync<T, E> =>

src/result-async.ts

@@ -381,6 +381,11 @@ export class Ok<T, E> implements IResult<T, E> {
   _unsafeUnwrapErr(config?: ErrorConfig): E {
     throw createNeverThrowError('Called `_unsafeUnwrapErr` on an Ok', this, config)
   }
+
+  // eslint-disable-next-line require-yield
+  *[Symbol.iterator](): Generator<Err<never, E>, T> {
+    return this.value
+  }
 }
 
 export class Err<T, E> implements IResult<T, E> {
@@ -467,6 +472,15 @@ export class Err<T, E> implements IResult<T, E> {
   _unsafeUnwrapErr(_?: ErrorConfig): E {
     return this.error
   }
+
+  *[Symbol.iterator](): Generator<Err<never, E>, T> {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const self = this
+    // @ts-expect-error -- This is structurally equivalent and safe
+    yield self
+    // @ts-expect-error -- This is structurally equivalent and safe
+    return self
+  }
 }
 
 export const fromThrowable = Result.fromThrowable