runtry 0.1.0 → 0.2.0

package/LICENSE

@@ -1,6 +1,21 @@
-Copyright 2026 sebastiansala
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+MIT License
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Copyright (c) 2026 Sebastian Sala
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,15 +1,173 @@
-# trycatchfinally
+# runtry
 
-To install dependencies:
+Run async functions and return a typed `Result` **instead of throwing**.
+
+- ✅ No repetitive `try/catch` in UI code
+- ✅ Typed success/error handling
+- ✅ Pluggable error normalization (matchers / adapters)
+
+---
+
+## Install
 
 ```bash
-bun install
+npm i runtry
+# or
+bun add runtry
+# or
+pnpm add runtry
 ```
 
-To run:
+---
 
-```bash
-bun run index.ts
+## Quick start
+
+```ts
+import { run } from "runtry";
+
+const result = await run(async () => {
+  // any async work
+  return 42;
+});
+
+if (result.ok) {
+  console.log("data:", result.data);
+} else {
+  console.error("error:", result.error.code, result.error.message);
+}
 ```
 
-This project was created using `bun init` in bun v1.2.9. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+---
+
+## API
+
+### `run(fn, options?)`
+
+```ts
+import type { AppError, RunOptions, RunResult } from "runtry";
+
+declare function run<T, E extends AppError = AppError>(
+  fn: () => Promise<T>,
+  options?: RunOptions<T, E>
+): Promise<RunResult<T, E>>;
+```
+
+- Returns `{ ok: true, data, error: null }` on success
+- Returns `{ ok: false, data: null, error }` on failure
+- Never throws (unless your callbacks throw)
+
+---
+
+## Normalizing errors (matchers)
+
+`runtry` can normalize unknown thrown values (`unknown`) into a consistent `AppError` shape.
+
+### 1) Create matchers (adapters)
+
+```ts
+import {
+  createNormalizer,
+  abortMatcher,
+  instanceOfMatcher,
+  defaultFallback,
+} from "runtry";
+import type { AppError } from "runtry";
+import { HttpError } from "./http-error"; // your app error class
+
+type MyMeta = { url?: string; body?: unknown };
+
+const httpMatcher = instanceOfMatcher(HttpError, (e) => ({
+  code: "HTTP",
+  message: e.message,
+  status: e.status,
+  meta: { url: e.url, body: e.body } as MyMeta,
+  cause: e,
+}));
+
+const toError = createNormalizer<AppError<MyMeta>>(
+  [abortMatcher, httpMatcher],
+  (e) => defaultFallback(e) as AppError<MyMeta>
+);
+```
+
+### 2) Use the normalizer in `run`
+
+```ts
+import { run } from "runtry";
+
+const res = await run(getDocuments, {
+  toError,
+  onError: (e) => console.log(e.status, e.message),
+});
+```
+
+---
+
+## `createClient()` (configure once, reuse everywhere)
+
+If you don't want to pass `toError` every time, create a client:
+
+```ts
+import {
+  createClient,
+  abortMatcher,
+  instanceOfMatcher,
+  defaultFallback,
+} from "runtry";
+import { HttpError } from "./http-error";
+
+const client = createClient({
+  matchers: [
+    abortMatcher,
+    instanceOfMatcher(HttpError, (e) => ({
+      code: "HTTP",
+      message: e.message,
+      status: e.status,
+      meta: { url: e.url, body: e.body },
+      cause: e,
+    })),
+  ],
+  fallback: defaultFallback,
+  ignoreAbort: true, // default
+});
+
+const result = await client.run(getDocuments, {
+  onError: (e) => console.log(e.code, e.message),
+});
+```
+
+---
+
+## React example (loading + toast, no try/catch)
+
+```ts
+import { createClient, abortMatcher, defaultFallback } from "runtry";
+
+const client = createClient({
+  matchers: [abortMatcher],
+  fallback: defaultFallback,
+});
+
+useEffect(() => {
+  let cancelled = false;
+  setIsLoading(true);
+
+  client.run(getDocuments, {
+    onSuccess: (docs) => {
+      if (cancelled) return;
+      setUploadedFiles(docs.map(mapper));
+    },
+    onError: (e) => {
+      if (e.code === "ABORTED") return;
+      toast.error(e.message);
+    },
+    onFinally: () => {
+      if (!cancelled) setIsLoading(false);
+    },
+  });
+
+  return () => {
+    cancelled = true;
+  };
+}, []);
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runtry",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Run async functions and return a typed Result instead of throwing.",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,5 +24,11 @@
     "@types/bun": "latest",
     "typescript": "^5.0.0"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "homepage": "https://github.com/sebastiansala/trysome#readme",
+  "bugs": "https://github.com/sebastiansala/trysome/issues",
+  "author": {
+    "name": "sebasxsala",
+    "url": "https://github.com/sebasxsala"
+  }
 }