@mkvlrn/result 6.0.0 → 6.0.2

package/build/index.d.ts

@@ -0,0 +1,22 @@
+//#region src/index.d.ts
+type ResultSync<T, E extends Error> = {
+  readonly isError: false;
+  readonly value: T;
+} | {
+  readonly isError: true;
+  readonly error: E;
+};
+declare const ResultSync: {
+  readonly ok: typeof ok;
+  readonly err: typeof err;
+};
+type ResultAsync<T, E extends Error> = Promise<ResultSync<T, E>>;
+declare const ResultAsync: {
+  readonly ok: typeof ok;
+  readonly err: typeof err;
+};
+declare function ok<T>(value: T): ResultSync<T, never>;
+declare function err<E extends Error>(error: E): ResultSync<never, E>;
+//#endregion
+export { ResultAsync, ResultSync };
+//# sourceMappingURL=index.d.ts.map

package/build/index.js

@@ -0,0 +1,35 @@
+//#region src/index.ts
+const ResultSync = {
+	ok,
+	err
+};
+const ResultAsync = {
+	ok,
+	err
+};
+/**
+* Creates a successful Result with the given value.
+* @param value The success value
+* @returns A Result object representing success
+*/
+function ok(value) {
+	return {
+		isError: false,
+		value
+	};
+}
+/**
+* Creates an error Result with the given error.
+* @param error The error value
+* @returns A Result object representing error
+*/
+function err(error) {
+	return {
+		isError: true,
+		error
+	};
+}
+//#endregion
+export { ResultAsync, ResultSync };
+
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Result type to represent the synchronous outcome of an operation.\n * It can either be a success with a value or an error.\n *\n * It is also an object containing the ok and err functions to\n * make it easier to create Result objects.\n */\nexport type ResultSync<T, E extends Error> =\n  | { readonly isError: false; readonly value: T }\n  | { readonly isError: true; readonly error: E };\n\nexport const ResultSync = { ok, err } as const;\n\n/**\n * Async version of Result type that wraps a Result in a Promise.\n *\n * It is also an object containing the ok and err functions to\n * make it easier to create Result objects for async workflows.\n */\nexport type ResultAsync<T, E extends Error> = Promise<ResultSync<T, E>>;\n\nexport const ResultAsync = { ok, err } as const;\n\n/**\n * Creates a successful Result with the given value.\n * @param value The success value\n * @returns A Result object representing success\n */\nfunction ok<T>(value: T): ResultSync<T, never> {\n  return { isError: false, value };\n}\n\n/**\n * Creates an error Result with the given error.\n * @param error The error value\n * @returns A Result object representing error\n */\nfunction err<E extends Error>(error: E): ResultSync<never, E> {\n  return { isError: true, error };\n}\n"],"mappings":";AAWA,MAAa,aAAa;CAAE;CAAI;AAAI;AAUpC,MAAa,cAAc;CAAE;CAAI;AAAI;;;;;;AAOrC,SAAS,GAAM,OAAgC;CAC7C,OAAO;EAAE,SAAS;EAAO;CAAM;AACjC;;;;;;AAOA,SAAS,IAAqB,OAAgC;CAC5D,OAAO;EAAE,SAAS;EAAM;CAAM;AAChC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mkvlrn/result",
   "description": "Simple Result type/pattern for TypeScript",
-  "version": "6.0.0",
+  "version": "6.0.2",
   "license": "MIT",
   "type": "module",
   "author": "Mike Valeriano <mkvlrn@gmail.com>",
@@ -34,5 +34,8 @@
     "tsdown": "0.22.14",
     "typescript": "^7.0.2",
     "vitest": "^4.1.10"
+  },
+  "scripts": {
+    "build": "tsdown"
   }
 }