@mkvlrn/result 3.0.0 → 4.0.1

package/README.md

@@ -1,6 +1,6 @@
-# Result Pattern
+# @mkvlrn/result
 
-Type-safe Result pattern for TypeScript representing success or failure.
+Type-safe Result pattern for TypeScript representing success or error. Anything to avoid try/catch hell.
 
 ## Installation
 
@@ -11,16 +11,16 @@ npm add @mkvlrn/result
 ## Usage
 
 ```typescript
-import { Result } from "@mkvlrn/result";
+import { Result, AsyncResult, R } from "@mkvlrn/result";
 
 // Success
-const success = Result.ok(42);
+const success = R.ok(42);
 
 // Error
-const failure = Result.error(new Error("Something went wrong"));
+const failure = R.error(new Error("Something went wrong"));
 
 // Check result
-const result = Result.ok(42);
+const result = R.ok(42);
 if (result.error) {
   console.log("Error:", result.error.message);
 } else {
@@ -35,9 +35,9 @@ if (result.error) {
 ```typescript
 function divide(a: number, b: number): Result<number, Error> {
   if (b === 0) {
-    return Result.error(new Error("Division by zero"));
+    return R.error(new Error("Division by zero"));
   }
-  return Result.ok(a / b);
+  return R.ok(a / b);
 }
 
 const result = divide(10, 2);
@@ -49,16 +49,16 @@ if (!result.error) {
 ### Async Operations
 
 ```typescript
-async function fetchUser(id: number): Promise<Result<User, Error>> {
+async function fetchUser(id: number): AsyncResult<User, Error> {
   try {
     const response = await fetch(`/api/users/${id}`);
     if (!response.ok) {
-      return Result.error(new Error(`HTTP ${response.status}`));
+      return R.error(new Error(`HTTP ${response.status}`));
     }
     const user = await response.json();
-    return Result.ok(user);
+    return R.ok(user);
   } catch (error) {
-    return Result.error(error instanceof Error ? error : new Error("Unknown error"));
+    return R.error(error instanceof Error ? error : new Error("Unknown error"));
   }
 }
 ```
@@ -71,7 +71,7 @@ class ValidationError extends Error {
 
   constructor(customField: number, message: string) {
     super(message);
-    this.name = "CustomField";
+    this.name = "ValidationError";
     this.customField = customField;
   }
 }

package/build/index.d.ts

@@ -12,7 +12,24 @@ export type Result<T, E extends Error> = {
 } | {
     readonly error: E;
 };
-export declare const Result: {
+/**
+ * Async version of Result type that wraps a Result in a Promise.
+ */
+export type AsyncResult<T, E extends Error> = Promise<Result<T, E>>;
+/**
+ * Result utility functions for creating Result objects.
+ */
+export declare const R: {
+    /**
+     * Creates a successful Result with the given value.
+     * @param value The success value
+     * @returns A Result object representing success
+     */
     ok<T>(value: T): Result<T, never>;
+    /**
+     * Creates an error Result with the given error.
+     * @param error The error value
+     * @returns A Result object representing error
+     */
     error<E extends Error>(error: E): Result<never, E>;
 };

package/build/index.js

@@ -1,14 +1,7 @@
-export const Result = {
-    /**
-     * Creates a successful Result with the given value.
-     * @param value The success value
-     * @returns A Result object representing success
-     */
+/**
+ * Result utility functions for creating Result objects.
+ */
+export const R = {
     ok: (value) => ({ error: undefined, value }),
-    /**
-     * Creates an error Result with the given error.
-     * @param error The error value
-     * @returns A Result object representing error
-     */
     error: (error) => ({ error }),
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mkvlrn/result",
   "description": "Result type for TypeScript",
-  "version": "3.0.0",
+  "version": "4.0.1",
   "license": "MIT",
   "type": "module",
   "publishConfig": {
@@ -20,8 +20,8 @@
     "build": "rm -rf build && tsc"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.1.1",
-    "@types/node": "^24.0.13",
+    "@biomejs/biome": "^2.1.3",
+    "@types/node": "^24.1.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   }

package/build/index.test.d.ts

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

package/build/index.test.js

@@ -1,53 +0,0 @@
-// biome-ignore lint/correctness/noNodejsModules: need the timer
-import { setTimeout } from "node:timers/promises";
-import { assert, describe, it } from "vitest";
-import { Result } from "./index.js";
-class CustomError extends Error {
-    customField;
-    constructor(customField, message) {
-        super(message);
-        this.name = "CustomField";
-        this.customField = customField;
-    }
-}
-function division(a, b) {
-    if (b === 0) {
-        return Result.error(new Error("cannot divide by zero"));
-    }
-    return Result.ok(a / b);
-}
-async function longRunning(shouldFail) {
-    await setTimeout(1);
-    return shouldFail ? Result.error(new CustomError(42, "wrong")) : Result.ok(3);
-}
-describe("creates a valid result", () => {
-    describe("default Error type", () => {
-        it("ok result", () => {
-            const result = division(4, 2);
-            assert.isUndefined(result.error);
-            assert.isDefined(result.value);
-            assert.strictEqual(result.value, 2);
-        });
-        it("error result", () => {
-            const result = division(4, 0);
-            assert.isDefined(result.error);
-            assert.instanceOf(result.error, Error);
-            assert.strictEqual(result.error.message, "cannot divide by zero");
-        });
-    });
-    describe("custom error", () => {
-        it("ok result", async () => {
-            const result = await longRunning(false);
-            assert.isUndefined(result.error);
-            assert.isDefined(result.value);
-            assert.strictEqual(result.value, 3);
-        });
-        it("error result", async () => {
-            const result = await longRunning(true);
-            assert.isDefined(result.error);
-            assert.instanceOf(result.error, CustomError);
-            assert.strictEqual(result.error.message, "wrong");
-            assert.strictEqual(result.error.customField, 42);
-        });
-    });
-});