@serkonda7/ts-result 1.0.0 → 1.0.2

package/README.md

@@ -1 +1,62 @@
 # ts-result
+[![CI][ci-badge]][ci-status]
+[![npm version][npm-badge]][npm-link]
+[![npm updated][npm-date-badge]][npm-link]
+
+Minimalistic Result type for TypeScript.
+
+
+## 📦 Installation
+```sh
+npm install @serkonda7/ts-result
+```
+
+
+## 🚀 Usage
+```ts
+import { ok, err, unwrap, type Result } from '@serkonda7/ts-result'
+
+// To use, wrap a functions return type into `Result<>`
+function parsePort (input: string): Result<number> {
+    const port = Number.parseInt(input, 10)
+
+    if (!Number.isInteger(port)) {
+        // Return an error result by using the `err()` helper
+        return err('PORT must be an integer')
+    }
+
+    if (port < 1 || port > 65535) {
+        // It supports strings, Error classes or any custom object
+        return err(new Error('PORT must be between 1 and 65535'))
+    }
+
+    // Return an successful result using the `ok()` helper
+    return ok(port)
+}
+
+const portResult = parsePort(process.env.PORT)
+
+// Check the result for an error:
+if (portResult.error) {
+    console.error(portResult.error)
+    process.exit(1)
+}
+
+// Use the value afterwards
+let port = portResult.value
+
+// Use the `unwrap()` helper to throw any error or return the value
+const port = unwrap(portResult)
+```
+
+
+## 📜 License
+This repo is licensed under the [MIT License](LICENSE.txt).
+
+
+<!-- links -->
+[ci-badge]: https://github.com/serkonda7/ts-result/actions/workflows/ci.yml/badge.svg
+[ci-status]: https://github.com/serkonda7/ts-result/actions/workflows/ci.yml
+[npm-badge]: https://nodei.co/npm/@serkonda7/ts-result.svg?style=shields&data=v&color=blue
+[npm-date-badge]: https://nodei.co/npm/@serkonda7/ts-result.svg?style=shields&data=u,d&color=blue
+[npm-link]: https://www.npmjs.com/package/@serkonda7/ts-result

package/dist/scripts/build.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/result.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Result utilities inspired by Rust's Result<T, E> type.
+ *
+ * This module provides a way to enforce explicit error handling.
+ */
+/** */
+type Ok<V> = {
+    value: V;
+    error?: never;
+};
+type Err<E> = {
+    error: E;
+    value?: never;
+};
+/**
+ * Union type representing either success or failure.
+ */
+export type Result<V, E = Error> = Ok<V> | Err<E>;
+/**
+ * Helper to create a successful Result.
+ */
+export declare const ok: <V>(value: V) => Ok<V>;
+/**
+ * Helper to create a failed Result.
+ */
+export declare const err: <E>(error: E) => Err<E>;
+/**
+ * Returns the `value` from a Result.
+ *
+ * In case of an error, it is thrown.
+ */
+export declare function unwrap<V, E>(result: Result<V, E>): V;
+export {};

package/dist/src/result.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@serkonda7/ts-result",
   "description": "Minimalistic Result type for TypeScript.",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "MIT",
   "author": "serkonda7",
   "homepage": "https://github.com/serkonda7/ts-result",
@@ -12,24 +12,27 @@
   "bugs": {
     "url": "https://github.com/serkonda7/ts-result/issues"
   },
-  "keywords": [],
+  "keywords": ["result", "typescript", "error-handling"],
   "type": "module",
-  "files": [
-    "dist/",
-    "README.md"
-  ],
+  "main": "dist/result.js",
+  "types": "dist/result.d.ts",
+  "files": ["dist/"],
   "scripts": {
-    "lint:fix": "biome check --write",
+    "lint": "biome check --write",
     "lint:ci": "biome ci",
-    "check": "bunx tsgo",
-    "build": "bun run check && bun run scripts/build.ts",
+    "check": "tsgo --noEmit",
+    "test": "bun test",
+    "build": "tsgo && bun run scripts/build.ts",
     "prepack": "bun run build"
   },
-  "packageManager": "bun@1.3.5",
+  "engines": {
+    "node": ">=22"
+  },
+  "packageManager": "bun@1.3.11",
   "dependencies": {},
   "devDependencies": {
-    "@biomejs/biome": "~2.3.11",
-    "@types/bun": "~1.3.5",
-    "@typescript/native-preview": "~7.0.0-dev.20260109.1"
+    "@biomejs/biome": "2.4.10",
+    "@types/bun": "~1.3.11",
+    "@typescript/native-preview": "~7.0.0-dev.20260325.1"
   }
 }