@mkvlrn/result 4.0.19 → 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/build/index.d.ts

@@ -1,3 +1,4 @@
+//#region src/index.d.ts
 /**
  * Result type to represent the outcome of an operation.
  * It can either be a success with a value or an error.
@@ -6,33 +7,30 @@
  * It is also an alias object containing the ok and error functions to
  * make it easier to create Result objects.
  */
-export type Result<T, E extends Error> = {
-    readonly isError: false;
-    readonly isOk: true;
-    readonly value: T;
+type Result<T, E extends Error> = {
+  readonly isError: false;
+  readonly isOk: true;
+  readonly value: T;
 } | {
-    readonly isError: true;
-    readonly isOk: false;
-    readonly error: E;
+  readonly isError: true;
+  readonly isOk: false;
+  readonly error: E;
 };
 /**
  * Async version of Result type that wraps a Result in a Promise.
  */
-export type AsyncResult<T, E extends Error> = Promise<Result<T, E>>;
+type AsyncResult<T, E extends Error> = Promise<Result<T, E>>;
 /**
- * Result utility functions for creating Result objects.
+ * Creates a successful Result with the given value.
+ * @param value The success value
+ * @returns A Result object representing success
  */
-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>;
-};
+declare function 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
+ */
+declare function err<E extends Error>(error: E): Result<never, E>;
+//#endregion
+export { AsyncResult, Result, err, ok };

package/build/index.js

@@ -1,7 +1 @@
-/**
- * Result utility functions for creating Result objects.
- */
-export const R = {
-    ok: (value) => ({ isError: false, isOk: true, value }),
-    error: (error) => ({ isError: true, isOk: false, error }),
-};
+function e(e){return{isError:!1,isOk:!0,value:e}}function t(e){return{isError:!0,isOk:!1,error:e}}export{t as err,e as ok};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mkvlrn/result",
   "description": "Simple Result type/pattern for TypeScript",
-  "version": "4.0.19",
+  "version": "5.0.1",
   "license": "MIT",
   "type": "module",
   "author": "Mike Valeriano <mkvlrn@proton.me>",
@@ -15,7 +15,7 @@
     "result"
   ],
   "engines": {
-    "node": "22.x"
+    "node": "24"
   },
   "files": [
     "build"
@@ -25,18 +25,20 @@
     "default": "./build/index.js"
   },
   "devDependencies": {
-    "@types/node": "^24.7.2",
-    "lint-staged": "^16.2.4",
-    "rimraf": "^6.0.1",
+    "@types/node": "^24.10.0",
+    "lint-staged": "^16.2.6",
+    "rimraf": "^6.1.0",
     "tsc-files": "^1.1.4",
+    "tsdown": "^0.16.1",
     "tsx": "^4.20.6",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "vite-tsconfig-paths": "^5.1.4"
   },
   "dependencies": {
-    "vitest": "^3.2.4"
+    "vitest": "^4.0.8"
   },
   "scripts": {
-    "build": "rimraf build && tsc -p tsconfig.build.json",
+    "build": "tsdown",
     "typecheck": "tsc"
   }
 }