@guillaume-docquier/tools-ts 1.4.0 → 2.0.0

package/dist/Result.d.ts

@@ -48,16 +48,25 @@ export declare const Result: {
  * If the promise rejects, you will get a {@link Result.Failure}.
  * If the promise rejects with a fatal error, the error will be rethrown.
  *
- * @param fn The callback to execute.
+ * @param promise The promise.
  */
-declare function tryCatch<T>(fn: () => Promise<T>): Promise<Result<T, unknown>>;
+declare function tryCatch<T>(promise: Promise<T>): Promise<Result<T, Error>>;
+/**
+ * Creates a Result from the result of a function that returns a promise.
+ * If the returned promise resolves, you will get a {@link Result.Success}.
+ * If the returned promise rejects, you will get a {@link Result.Failure}.
+ * If the returned promise rejects with a fatal error, the error will be rethrown.
+ *
+ * @param asyncFn The asynchronous callback to execute.
+ */
+declare function tryCatch<T>(asyncFn: () => Promise<T>): Promise<Result<T, Error>>;
 /**
  * Creates a Result from the result of a function that could throw.
  * If the function does not throw, you will get a {@link Result.Success}.
  * If the function throws, you will get a {@link Result.Failure}.
  * If the function throws a fatal error, the error will be rethrown.
  *
- * @param fn The callback to execute.
+ * @param syncFn The synchronous callback to execute.
  */
-declare function tryCatch<T>(fn: () => T): Result<T, unknown>;
+declare function tryCatch<T>(syncFn: () => T): Result<T, Error>;
 export {};

package/dist/Result.js

@@ -35,15 +35,15 @@ export const Result = {
     // You can't overload while defining object properties, which is why the function implementation is not inlined
     tryCatch,
 };
-function tryCatch(fn) {
+function tryCatch(op) {
+    if (op instanceof Promise) {
+        return tryCatchPromise(op);
+    }
     try {
-        const result = fn();
+        const result = op();
         // Async handling
         if (result instanceof Promise) {
-            return result.then(Result.Success).catch((error) => {
-                Rethrow.ifFatal(error);
-                return Result.Failure(error);
-            });
+            return tryCatchPromise(result);
         }
         // Sync handling
         return Result.Success(result);
@@ -53,4 +53,10 @@ function tryCatch(fn) {
         return Result.Failure(error);
     }
 }
+function tryCatchPromise(promise) {
+    return promise.then(Result.Success).catch((error) => {
+        Rethrow.ifFatal(error);
+        return Result.Failure(error);
+    });
+}
 //# sourceMappingURL=Result.js.map

package/dist/Result.js.map

@@ -1 +1 @@
-{"version":3,"file":"Result.js","sourceRoot":"","sources":["../src/Result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAkB7C;;;;;;;;;;;GAWG;AAEH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB;;OAEG;IACH,OAAO,EAAE,CAAS,KAAa,EAAmB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAEjF;;OAEG;IACH,SAAS,EAAE,CAAS,YAAqC,EAAmC,EAAE;QAC5F,OAAO,YAAY,CAAC,IAAI,KAAK,SAAS,CAAA;IACxC,CAAC;IAED;;OAEG;IACH,OAAO,EAAE,CAAS,KAAa,EAAmB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAEjF;;OAEG;IACH,SAAS,EAAE,CAAS,YAAqC,EAAmC,EAAE;QAC5F,OAAO,YAAY,CAAC,IAAI,KAAK,SAAS,CAAA;IACxC,CAAC;IAED,+GAA+G;IAC/G,QAAQ;CACT,CAAA;AAoBD,SAAS,QAAQ,CAAI,EAAwB;IAC3C,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,EAAE,EAAE,CAAA;QAEnB,iBAAiB;QACjB,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACtB,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAC9B,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,gBAAgB;QAChB,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACtB,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;AACH,CAAC"}
+{"version":3,"file":"Result.js","sourceRoot":"","sources":["../src/Result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAkB7C;;;;;;;;;;;GAWG;AAEH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB;;OAEG;IACH,OAAO,EAAE,CAAS,KAAa,EAAmB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAEjF;;OAEG;IACH,SAAS,EAAE,CAAS,YAAqC,EAAmC,EAAE;QAC5F,OAAO,YAAY,CAAC,IAAI,KAAK,SAAS,CAAA;IACxC,CAAC;IAED;;OAEG;IACH,OAAO,EAAE,CAAS,KAAa,EAAmB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAEjF;;OAEG;IACH,SAAS,EAAE,CAAS,YAAqC,EAAmC,EAAE;QAC5F,OAAO,YAAY,CAAC,IAAI,KAAK,SAAS,CAAA;IACxC,CAAC;IAED,+GAA+G;IAC/G,QAAQ;CACT,CAAA;AA6BD,SAAS,QAAQ,CAAI,EAAuC;IAC1D,IAAI,EAAE,YAAY,OAAO,EAAE,CAAC;QAC1B,OAAO,eAAe,CAAC,EAAE,CAAC,CAAA;IAC5B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,EAAE,EAAE,CAAA;QAEnB,iBAAiB;QACjB,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,OAAO,eAAe,CAAC,MAAM,CAAC,CAAA;QAChC,CAAC;QAED,gBAAgB;QAChB,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACtB,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAI,OAAmB;IAC7C,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAClD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACtB,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guillaume-docquier/tools-ts",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "My personal collection of typescript tools",
   "homepage": "https://github.com/Guillaume-Docquier/tools-ts",
   "repository": {
@@ -21,11 +21,12 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc --project tsconfig.build.json",
+    "checks": "pnpm lint:fix && pnpm format:fix && pnpm typecheck && pnpm test --run",
     "format": "prettier --check . && pnpm format:package-json --check",
     "format:fix": "prettier --write --list-different . && pnpm format:package-json",
     "format:package-json": "sort-package-json package.json",
     "lint": "eslint . --max-warnings 0",
-    "lint:fix": "pnpm lint -- --fix",
+    "lint:fix": "pnpm lint --fix",
     "prepack": "pnpm build",
     "prepare": "husky",
     "prepublishOnly": "pnpm i",