@mkvlrn/result 1.1.4 → 2.0.0

package/build/index.d.ts

@@ -3,17 +3,16 @@
  * It can either be a success with a value or an error with an error message.
  * This is a generic type that can be used with any type of value and error.
  *
- * It is also an alias object containing the success and error functions to
+ * 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 = Error> = {
-    readonly ok: true;
+    readonly error: undefined;
     readonly value: T;
 } | {
-    readonly ok: false;
     readonly error: E;
 };
 export declare const Result: {
-    success<T>(value: T): Result<T, never>;
+    ok<T>(value: T): Result<T, never>;
     error<E = Error>(error: E): Result<never, E>;
 };

package/build/index.js

@@ -1,15 +1,14 @@
-// biome-ignore lint/nursery/useExplicitType: https://github.com/biomejs/biome/issues/5932
 export const Result = {
     /**
      * Creates a successful Result with the given value.
      * @param value The success value
      * @returns A Result object representing success
      */
-    success: (value) => ({ ok: true, value: value }),
+    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) => ({ ok: false, error: error }),
+    error: (error) => ({ error }),
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mkvlrn/result",
   "description": "Result type for TypeScript",
-  "version": "1.1.4",
+  "version": "2.0.0",
   "license": "MIT",
   "type": "module",
   "publishConfig": {
@@ -19,7 +19,7 @@
     "build": "rm -rf build && tsc"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.0.0-beta.3",
+    "@biomejs/biome": "^2.0.6",
     "typescript": "^5.8.3"
   }
 }