@mkvlrn/result 5.0.0 → 5.0.1

package/README.md

@@ -11,17 +11,17 @@ 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);
@@ -35,13 +35,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.isError) {
   console.log(result.value); // 5
 }
 ```
@@ -53,12 +53,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 +78,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.1",
   "license": "MIT",
   "type": "module",
   "author": "Mike Valeriano <mkvlrn@proton.me>",