@mkvlrn/result 6.0.1 → 6.0.2

package/build/index.d.ts

@@ -1,23 +1,22 @@
 //#region src/index.d.ts
-type SyncResult<T, E extends Error> = {
+type ResultSync<T, E extends Error> = {
   readonly isError: false;
   readonly value: T;
 } | {
   readonly isError: true;
   readonly error: E;
 };
-declare const ok: <T>(value: T) => SyncResult<T, never>;
-declare const err: <E extends Error>(error: E) => SyncResult<never, E>;
-type ResultSync<T, E extends Error> = SyncResult<T, E>;
 declare const ResultSync: {
-  ok: typeof ok;
-  err: typeof err;
+  readonly ok: typeof ok;
+  readonly err: typeof err;
 };
-type ResultAsync<T, E extends Error> = Promise<SyncResult<T, E>>;
+type ResultAsync<T, E extends Error> = Promise<ResultSync<T, E>>;
 declare const ResultAsync: {
-  ok: typeof ok;
-  err: typeof err;
+  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

@@ -1,50 +1,34 @@
 //#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
 */
-const ok = (value) => ({
-	isError: false,
-	value
-});
+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
 */
-const err = (error) => ({
-	isError: true,
-	error
-});
-const ResultSync = {
-	/**
-	* Creates a successful Result with the given value.
-	* @param value The success value
-	* @returns A Result object representing success
-	*/
-	ok,
-	/**
-	* Creates an error Result with the given error.
-	* @param error The error value
-	* @returns A Result object representing error
-	*/
-	err
-};
-const ResultAsync = {
-	/**
-	* Creates a successful Result with the given value.
-	* @param value The success value
-	* @returns A Result object representing success
-	*/
-	ok,
-	/**
-	* Creates an error Result with the given error.
-	* @param error The error value
-	* @returns A Result object representing error
-	*/
-	err
-};
+function err(error) {
+	return {
+		isError: true,
+		error
+	};
+}
 //#endregion
 export { ResultAsync, ResultSync };
 

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["type SyncResult<T, E extends Error> =\n  | { readonly isError: false; readonly value: T }\n  | { readonly isError: true; readonly error: E };\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 */\nconst ok = <T>(value: T): SyncResult<T, never> => ({\n  isError: false,\n  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 */\nconst err = <E extends Error>(error: E): SyncResult<never, E> => ({\n  isError: true,\n  error,\n});\n\n/**\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> = SyncResult<T, E>;\n\nexport const ResultSync = {\n  /**\n   * Creates a successful Result with the given value.\n   * @param value The success value\n   * @returns A Result object representing success\n   */\n  ok,\n  /**\n   * Creates an error Result with the given error.\n   * @param error The error value\n   * @returns A Result object representing error\n   */\n  err,\n};\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<SyncResult<T, E>>;\n\nexport const ResultAsync = {\n  /**\n   * Creates a successful Result with the given value.\n   * @param value The success value\n   * @returns A Result object representing success\n   */\n  ok,\n  /**\n   * Creates an error Result with the given error.\n   * @param error The error value\n   * @returns A Result object representing error\n   */\n  err,\n};\n"],"mappings":";;;;;;AASA,MAAM,MAAS,WAAoC;CACjD,SAAS;CACT;AACF;;;;;;AAOA,MAAM,OAAwB,WAAoC;CAChE,SAAS;CACT;AACF;AAWA,MAAa,aAAa;;;;;;CAMxB;;;;;;CAMA;AACF;AAUA,MAAa,cAAc;;;;;;CAMzB;;;;;;CAMA;AACF"}
+{"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.1",
+  "version": "6.0.2",
   "license": "MIT",
   "type": "module",
   "author": "Mike Valeriano <mkvlrn@gmail.com>",