@serkonda7/ts-result 1.0.3 → 1.0.5

package/README.md

@@ -6,6 +6,11 @@
 Minimalistic Result type for TypeScript.
 
 
+## ⚠️ Archived
+This project is archived.
+I recommend using [better-result](https://github.com/dmmulroy/better-result) instead.
+
+
 ## 📦 Installation
 ```sh
 npm install @serkonda7/ts-result
@@ -26,7 +31,7 @@ function parsePort (input: string): Result<number> {
     }
 
     if (port < 1 || port > 65535) {
-        // It supports strings, Error classes or any custom object
+      // It supports strings and Error classes
         return err(new Error('PORT must be between 1 and 65535'))
     }
 
@@ -50,6 +55,33 @@ const port = unwrap(portResult)
 ```
 
 
+## 🧹 Linter Configuration
+To avoid exception-based control flow, configure your linter to disallow `throw` statements in application code.
+
+### Biome example configuration
+```gritql
+// no-throw.grit
+
+language js (typescript, jsx);
+
+`throw $expr` as $throw where {
+  register_diagnostic(
+    span = $throw,
+    message = "Use Result 'return err(...)' instead of `throw`"
+  )
+}
+```
+
+```jsonc
+// biome.jsonc
+
+{
+  // ...
+  "plugins": ["./no-throw.grit"]
+}
+```
+
+
 ## 📜 License
 This repo is licensed under the [MIT License](LICENSE.txt).
 

package/dist/src/result.d.ts

@@ -12,10 +12,11 @@ type Err<E> = {
     error: E;
     value?: never;
 };
+type ErrorTypes = string | Error;
 /**
  * Union type representing either success or failure.
  */
-export type Result<V, E = Error> = Ok<V> | Err<E>;
+export type Result<V, E = ErrorTypes> = Ok<V> | Err<E>;
 /**
  * Helper to create a successful Result.
  */
@@ -23,7 +24,7 @@ export declare const ok: <V>(value: V) => Ok<V>;
 /**
  * Helper to create a failed Result.
  */
-export declare const err: <E>(error: E) => Err<E>;
+export declare const err: <E extends ErrorTypes>(error: E) => Err<E>;
 /**
  * Returns the `value` from a Result.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@serkonda7/ts-result",
   "description": "Minimalistic Result type for TypeScript.",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "license": "MIT",
   "author": "serkonda7",
   "homepage": "https://github.com/serkonda7/ts-result",
@@ -20,20 +20,20 @@
   "scripts": {
     "lint": "biome check --write",
     "lint:ci": "biome ci",
-    "check": "tsgo -p tsconfig.check.json",
+    "check": "tsgo",
     "test": "bun test",
-    "build": "tsgo && bun run scripts/build.ts",
+    "build": "tsgo -p tsconfig.build.json && bun run scripts/build.ts",
     "prepack": "bun run build",
     "pack": "bun pm pack --filename ts-result.tgz"
   },
   "engines": {
     "node": ">=22"
   },
-  "packageManager": "bun@1.3.11",
+  "packageManager": "bun@1.3.13",
   "dependencies": {},
   "devDependencies": {
-    "@biomejs/biome": "2.4.10",
-    "@types/bun": "~1.3.11",
-    "@typescript/native-preview": "~7.0.0-dev.20260325.1"
+    "@biomejs/biome": "2.4.15",
+    "@types/bun": "~1.3.13",
+    "@typescript/native-preview": "~7.0.0-dev.20260511.1"
   }
 }