@mkvlrn/result 5.0.0 → 5.0.2

package/README.md

@@ -2,6 +2,8 @@
 
 Type-safe Result pattern for TypeScript representing success or error. Anything to avoid try/catch hell.
 
+[![npm](https://img.shields.io/npm/v/@mkvlrn/result)](https://www.npmjs.com/package/@mkvlrn/result)
+
 ## Installation
 
 ```bash
@@ -11,23 +13,32 @@ pnpm add @mkvlrn/result
 ## Usage
 
 ```typescript
-import { Result, AsyncResult, R } from "@mkvlrn/result";
+import { Result, AsyncResult, ok, err } from "@mkvlrn/result";
 
 // Success
-const success = R.ok(42);
+const success = ok(42);
 
 // Error
-const failure = R.error(new Error("Something went wrong"));
+const failure = err(new Error("Something went wrong"));
 
 // Check result
-const result = R.ok(42);
-if (result.error) {
+const result = ok(42);
+if (result.isError) {
   console.log("Error:", result.error.message);
 } else {
   console.log("Value:", result.value);
 }
 ```
 
+## API
+
+| Export              | Description                                  |
+| ------------------- | -------------------------------------------- |
+| `Result<T, E>`      | Union type representing success or failure   |
+| `AsyncResult<T, E>` | `Promise<Result<T, E>>` for async operations |
+| `ok(value)`         | Creates a success result                     |
+| `err(error)`        | Creates an error result                      |
+
 ## Examples
 
 ### Basic Function
@@ -35,13 +46,13 @@ if (result.error) {
 ```typescript
 function divide(a: number, b: number): Result<number, Error> {
   if (b === 0) {
-    return R.error(new Error("Division by zero"));
+    return err(new Error("Division by zero"));
   }
-  return R.ok(a / b);
+  return ok(a / b);
 }
 
 const result = divide(10, 2);
-if (!result.error) {
+if (result.isOk) {
   console.log(result.value); // 5
 }
 ```
@@ -53,12 +64,12 @@ async function fetchUser(id: number): AsyncResult<User, Error> {
   try {
     const response = await fetch(`/api/users/${id}`);
     if (!response.ok) {
-      return R.error(new Error(`HTTP ${response.status}`));
+      return err(new Error(`HTTP ${response.status}`));
     }
     const user = await response.json();
-    return R.ok(user);
+    return ok(user);
   } catch (error) {
-    return R.error(error instanceof Error ? error : new Error("Unknown error"));
+    return err(error instanceof Error ? error : new Error("Unknown error"));
   }
 }
 ```
@@ -78,13 +89,13 @@ class ValidationError extends Error {
 
 function validateEmail(email: string): Result<string, ValidationError> {
   if (!email.includes("@")) {
-    return Result.error(new ValidationError(400, "custom"));
+    return err(new ValidationError(400, "custom"));
   }
-  return Result.ok(email);
+  return ok(email);
 }
 
 const result = validateEmail("invalid-email");
-if (result.error) {
+if (result.isError) {
   console.log(`${result.error.customField}: ${result.error.message}`);
 }
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mkvlrn/result",
   "description": "Simple Result type/pattern for TypeScript",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "license": "MIT",
   "type": "module",
   "author": "Mike Valeriano <mkvlrn@proton.me>",
@@ -25,17 +25,17 @@
     "default": "./build/index.js"
   },
   "devDependencies": {
-    "@types/node": "^24.10.0",
-    "lint-staged": "^16.2.6",
-    "rimraf": "^6.1.0",
+    "@types/node": "^25.0.3",
+    "lint-staged": "^16.2.7",
+    "rimraf": "^6.1.2",
     "tsc-files": "^1.1.4",
-    "tsdown": "^0.16.1",
-    "tsx": "^4.20.6",
+    "tsdown": "^0.18.2",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vite-tsconfig-paths": "^5.1.4"
+    "vite-tsconfig-paths": "^6.0.3"
   },
   "dependencies": {
-    "vitest": "^4.0.8"
+    "vitest": "^4.0.16"
   },
   "scripts": {
     "build": "tsdown",