try-catch-util 1.0.7 → 1.0.9

package/Readme.md

@@ -28,12 +28,8 @@ const { result, error } = await tryCatch<TodosResponse>(async () => {
   return response.json() as Promise<TodosResponse>;
 });
 
-if (error) {
-  console.error(error.message);
-  return;
-}
-
-console.log(result.todos);
+if (error) console.error(error.message);
+else console.log(result.todos);
 ```
 
 `error` is typed as `Error`, so `error.message` needs no cast.
@@ -43,18 +39,8 @@ console.log(result.todos);
 ```ts
 import { tryCatch } from 'try-catch-util';
 
-type TodosResponse = {
-  todos: Array<{ id: number; todo: string; completed: boolean; userId: number }>;
-  total: number;
-  skip: number;
-  limit: number;
-};
-
 class TodosApiError extends Error {
-  constructor(
-    message: string,
-    public readonly status: number,
-  ) {
+  constructor(message: string, public readonly status: number) {
     super(message);
     this.name = 'TodosApiError';
   }
@@ -66,12 +52,8 @@ const { result, error } = await tryCatch<TodosResponse, TodosApiError>(async ()
   return response.json() as Promise<TodosResponse>;
 });
 
-if (error) {
-  console.error(error.status, error.message);
-  return;
-}
-
-console.log(result.todos.map((todo) => todo.todo));
+if (error) console.error(error.status, error.message);
+else console.log(result.todos.map((todo) => todo.todo));
 ```
 
 `error` is typed as `TodosApiError`, so `error.status` needs no cast.
@@ -93,12 +75,10 @@ import type { Result } from 'try-catch-util';
 ## API
 
 ```ts
-function tryCatch<T, E extends Error = Error>(
-  input: () => Promise<T> | T,
-): Promise<Result<T, E>>;
+function tryCatch<T, E extends Error = Error>(input: () => Promise<T> | T): Promise<Result<T, E>>;
 ```
 
-If a function throws or rejects with a string, `tryCatch` converts it into an `Error` instance. Other thrown values are preserved as-is.
+> Note: If a function throws or rejects with a string, `tryCatch` converts it into an `Error` instance. Other thrown values are preserved as-is.
 
 ## License
 

package/dist/cjs/index.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts"],
-  "sourcesContent": ["export type Success<T> = { result: T; error?: never };\nexport type Failure<E> = { result?: never; error: E };\nexport type Result<T, E extends Error = Error> = Success<T> | Failure<E>;\n\n/**\n * Executes a synchronous or asynchronous function and returns a typed result object.\n *\n * Successful executions resolve with `{ result }`, while thrown errors resolve with\n * `{ error }`. If a string is thrown, it is converted into an `Error` instance.\n *\n * @param input - Function to execute safely.\n * @returns A promise containing either the function result or the captured error.\n */\nexport async function tryCatch<T, E extends Error = Error>(input: () => Promise<T> | T): Promise<Result<T, E>> {\n  try {\n    const result = await input();\n    return { result };\n  } catch (e) {\n    const error = typeof e === 'string' ? (new Error(String(e)) as E) : (e as E);\n    return { error };\n  }\n}\n"],
-  "mappings": "4dAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,cAAAE,IAAA,eAAAC,EAAAH,GAaA,eAAsBI,EAAqCC,EAAoD,CAC7G,GAAI,CAEF,MAAO,CAAE,OADM,MAAMA,EAAM,CACX,CAClB,OAASC,EAAG,CAEV,MAAO,CAAE,MADK,OAAOA,GAAM,SAAY,IAAI,MAAM,OAAOA,CAAC,CAAC,EAAWA,CACtD,CACjB,CACF,CARsBC,EAAAH,EAAA",
+  "sourcesContent": ["export type Success<T> = { result: T; error?: never };\nexport type Failure<E> = { result?: never; error: E };\nexport type Result<T, E extends Error = Error> = Success<T> | Failure<E>;\n\n/**\n * Executes a synchronous or asynchronous function and returns a typed result object.\n * Successful executions resolve with `{ result }`, while thrown errors resolve with\n * `{ error }`. If a string is thrown, it is converted into an `Error` instance.\n * @param input - Function to execute safely without messy try/catch blocks.\n * @returns A promise containing either the function result or the captured error.\n */\nexport async function tryCatch<T, E extends Error = Error>(input: () => Promise<T> | T): Promise<Result<T, E>> {\n  try {\n    const result = await input();\n    return { result };\n  } catch (e) {\n    const error = typeof e === 'string' ? (new Error(String(e)) as E) : (e as E);\n    return { error };\n  }\n}\n"],
+  "mappings": "4dAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,cAAAE,IAAA,eAAAC,EAAAH,GAWA,eAAsBI,EAAqCC,EAAoD,CAC7G,GAAI,CAEF,MAAO,CAAE,OADM,MAAMA,EAAM,CACX,CAClB,OAASC,EAAG,CAEV,MAAO,CAAE,MADK,OAAOA,GAAM,SAAY,IAAI,MAAM,OAAOA,CAAC,CAAC,EAAWA,CACtD,CACjB,CACF,CARsBC,EAAAH,EAAA",
   "names": ["index_exports", "__export", "tryCatch", "__toCommonJS", "tryCatch", "input", "e", "__name"]
 }

package/dist/esm/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts"],
-  "sourcesContent": ["export type Success<T> = { result: T; error?: never };\nexport type Failure<E> = { result?: never; error: E };\nexport type Result<T, E extends Error = Error> = Success<T> | Failure<E>;\n\n/**\n * Executes a synchronous or asynchronous function and returns a typed result object.\n *\n * Successful executions resolve with `{ result }`, while thrown errors resolve with\n * `{ error }`. If a string is thrown, it is converted into an `Error` instance.\n *\n * @param input - Function to execute safely.\n * @returns A promise containing either the function result or the captured error.\n */\nexport async function tryCatch<T, E extends Error = Error>(input: () => Promise<T> | T): Promise<Result<T, E>> {\n  try {\n    const result = await input();\n    return { result };\n  } catch (e) {\n    const error = typeof e === 'string' ? (new Error(String(e)) as E) : (e as E);\n    return { error };\n  }\n}\n"],
-  "mappings": "+EAaA,eAAsBA,EAAqCC,EAAoD,CAC7G,GAAI,CAEF,MAAO,CAAE,OADM,MAAMA,EAAM,CACX,CAClB,OAASC,EAAG,CAEV,MAAO,CAAE,MADK,OAAOA,GAAM,SAAY,IAAI,MAAM,OAAOA,CAAC,CAAC,EAAWA,CACtD,CACjB,CACF,CARsBC,EAAAH,EAAA",
+  "sourcesContent": ["export type Success<T> = { result: T; error?: never };\nexport type Failure<E> = { result?: never; error: E };\nexport type Result<T, E extends Error = Error> = Success<T> | Failure<E>;\n\n/**\n * Executes a synchronous or asynchronous function and returns a typed result object.\n * Successful executions resolve with `{ result }`, while thrown errors resolve with\n * `{ error }`. If a string is thrown, it is converted into an `Error` instance.\n * @param input - Function to execute safely without messy try/catch blocks.\n * @returns A promise containing either the function result or the captured error.\n */\nexport async function tryCatch<T, E extends Error = Error>(input: () => Promise<T> | T): Promise<Result<T, E>> {\n  try {\n    const result = await input();\n    return { result };\n  } catch (e) {\n    const error = typeof e === 'string' ? (new Error(String(e)) as E) : (e as E);\n    return { error };\n  }\n}\n"],
+  "mappings": "+EAWA,eAAsBA,EAAqCC,EAAoD,CAC7G,GAAI,CAEF,MAAO,CAAE,OADM,MAAMA,EAAM,CACX,CAClB,OAASC,EAAG,CAEV,MAAO,CAAE,MADK,OAAOA,GAAM,SAAY,IAAI,MAAM,OAAOA,CAAC,CAAC,EAAWA,CACtD,CACjB,CACF,CARsBC,EAAAH,EAAA",
   "names": ["tryCatch", "input", "e", "__name"]
 }

package/dist/index.d.ts

@@ -9,11 +9,9 @@ export type Failure<E> = {
 export type Result<T, E extends Error = Error> = Success<T> | Failure<E>;
 /**
  * Executes a synchronous or asynchronous function and returns a typed result object.
- *
  * Successful executions resolve with `{ result }`, while thrown errors resolve with
  * `{ error }`. If a string is thrown, it is converted into an `Error` instance.
- *
- * @param input - Function to execute safely.
+ * @param input - Function to execute safely without messy try/catch blocks.
  * @returns A promise containing either the function result or the captured error.
  */
 export declare function tryCatch<T, E extends Error = Error>(input: () => Promise<T> | T): Promise<Result<T, E>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "try-catch-util",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A simple util to wrap sync/async functions and handle errors type-safely.",
   "keywords": [
     "try catch",
@@ -35,7 +35,8 @@
     "check": "biome check .",
     "test": "jest",
     "build": "tsc --build --noEmit && tsx esbuild.config.ts",
-    "prepublishOnly": "npm run build && npm test"
+    "prepublishOnly": "npm run build && npm test",
+    "patch": "npm version patch -m \"chore(release): %s [skip ci]\""
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.16",