@mkvlrn/result 5.0.3 → 5.0.4

package/build/index.d.ts

@@ -0,0 +1,36 @@
+//#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.
+ * This is a generic type that can be used with any type of value and error (should extend Error).
+ *
+ * It is also an alias object containing the ok and error functions to
+ * make it easier to create Result objects.
+ */
+type Result<T, E extends Error> = {
+  readonly isError: false;
+  readonly isOk: true;
+  readonly value: T;
+} | {
+  readonly isError: true;
+  readonly isOk: false;
+  readonly error: E;
+};
+/**
+ * Async version of Result type that wraps a Result in a Promise.
+ */
+type AsyncResult<T, E extends Error> = Promise<Result<T, E>>;
+/**
+ * Creates a successful Result with the given value.
+ * @param value The success value
+ * @returns A Result object representing success
+ */
+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

@@ -0,0 +1 @@
+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": "5.0.3",
+  "version": "5.0.4",
   "license": "MIT",
   "type": "module",
   "author": "Mike Valeriano <mkvlrn@proton.me>",