@oscarpalmer/atoms 0.148.0 → 0.149.0

package/dist/atoms.full.js

@@ -3536,6 +3536,29 @@ const ALPHABET = "abcdefghijklmnopqrstuvwxyz";
 const BOOLEAN_MODIFIER = .5;
 const HEX_CHARACTERS = "0123456789ABCDEF";
 const HEX_MAXIMUM = 15;
+async function asyncMatchResult(result, first, error) {
+	let value;
+	if (typeof result === "function") value = await result();
+	else if (result instanceof Promise) value = await result;
+	else value = result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+function matchResult(result, first, error) {
+	const value = typeof result === "function" ? result() : result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+matchResult.async = asyncMatchResult;
+const MESSAGE_RESULT = "`result.match` expected a Result or a function that returns a Result";
 function attemptAsyncFlow(...fns) {
 	let Flow;
 	return (...args) => attempt.async(() => {
@@ -3592,6 +3615,7 @@ function attempt(callback, err) {
 }
 attempt.async = asyncAttempt;
 attempt.flow = attemptFlow;
+attempt.match = matchResult;
 attempt.pipe = attemptPipe;
 attempt.promise = attemptPromise;
 function error(value, original) {

package/dist/result/index.js

@@ -1,5 +1,6 @@
 import { isError, isOk, isResult } from "../internal/result.js";
 import { attemptPromise } from "../promise.js";
+import { matchResult } from "./match.js";
 import { attemptFlow } from "./work/flow.js";
 import { attemptPipe } from "./work/pipe.js";
 async function asyncAttempt(value, err) {
@@ -20,6 +21,7 @@ function attempt(callback, err) {
 }
 attempt.async = asyncAttempt;
 attempt.flow = attemptFlow;
+attempt.match = matchResult;
 attempt.pipe = attemptPipe;
 attempt.promise = attemptPromise;
 function error(value, original) {

package/dist/result/match.js

@@ -0,0 +1,25 @@
+import { isOk, isResult } from "../internal/result.js";
+async function asyncMatchResult(result, first, error) {
+	let value;
+	if (typeof result === "function") value = await result();
+	else if (result instanceof Promise) value = await result;
+	else value = result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+function matchResult(result, first, error) {
+	const value = typeof result === "function" ? result() : result;
+	if (!isResult(value)) throw new Error(MESSAGE_RESULT);
+	const hasObj = typeof first === "object" && first !== null;
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+	if (isOk(value)) return okHandler(value.value);
+	return errorHandler(value.error, value.original);
+}
+matchResult.async = asyncMatchResult;
+var MESSAGE_RESULT = "`result.match` expected a Result or a function that returns a Result";
+export { matchResult };

package/package.json

@@ -192,5 +192,5 @@
 	},
 	"type": "module",
 	"types": "./types/index.d.ts",
-	"version": "0.148.0"
+	"version": "0.149.0"
 }

package/src/result/index.ts

@@ -1,5 +1,6 @@
 import {isOk} from '../internal/result';
 import {attemptPromise} from '../promise';
+import {matchResult} from './match';
 import type {Err, ExtendedErr, ExtendedResult, Ok, Result} from './models';
 import {attemptFlow} from './work/flow';
 import {attemptPipe} from './work/pipe';
@@ -65,7 +66,7 @@ async function asyncAttempt<Value, E>(
  * @param error Error value
  * @returns Callback result
  */
-export function attempt<Value, E>(callback: () => Value, error: E): ExtendedErr<E> | Ok<Value>;
+export function attempt<Value, E>(callback: () => Value, error: E): ExtendedResult<Value, E>;
 
 /**
  * Executes a callback, catching any errors, and returns a result
@@ -89,6 +90,7 @@ export function attempt<Value, E>(
 
 attempt.async = asyncAttempt;
 attempt.flow = attemptFlow;
+attempt.match = matchResult;
 attempt.pipe = attemptPipe;
 attempt.promise = attemptPromise;
 

package/src/result/match.ts

@@ -0,0 +1,112 @@
+import {isOk, isResult} from '../internal/result';
+import type {AnyResult, ExtendedErr, ResultMatch} from './models';
+
+// #region Functions
+
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param handler Match callbacks
+ */
+async function asyncMatchResult<Value, Returned, E = Error>(
+	result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>),
+	handler: ResultMatch<Value, Returned, E>,
+): Promise<Returned>;
+
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param ok Ok callback
+ * @param error Error callback
+ */
+async function asyncMatchResult<Value, Returned, E = Error>(
+	result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>),
+	ok: ResultMatch<Value, Returned, E>['ok'],
+	error: ResultMatch<Value, Returned, E>['error'],
+): Promise<Returned>;
+
+async function asyncMatchResult<Value, Returned, E = Error>(
+	result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>),
+	first: ResultMatch<Value, Returned, E> | ResultMatch<Value, Returned, E>['ok'],
+	error?: ResultMatch<Value, Returned, E>['error'],
+): Promise<Returned> {
+	let value: AnyResult<Value, E>;
+
+	if (typeof result === 'function') {
+		value = await result();
+	} else if (result instanceof Promise) {
+		value = await result;
+	} else {
+		value = result;
+	}
+
+	if (!isResult(value)) {
+		throw new Error(MESSAGE_RESULT);
+	}
+
+	const hasObj = typeof first === 'object' && first !== null;
+
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+
+	if (isOk(value)) {
+		return okHandler(value.value);
+	}
+
+	return errorHandler!(value.error, (value as ExtendedErr<E>).original);
+}
+
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param handler Match callbacks
+ */
+export function matchResult<Value, Returned, E = Error>(
+	result: AnyResult<Value, E> | (() => AnyResult<Value, E>),
+	handler: ResultMatch<Value, Returned, E>,
+): Returned;
+
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param ok Ok callback
+ * @param error Error callback
+ */
+export function matchResult<Value, Returned, E = Error>(
+	result: AnyResult<Value, E> | (() => AnyResult<Value, E>),
+	ok: ResultMatch<Value, Returned, E>['ok'],
+	error: ResultMatch<Value, Returned, E>['error'],
+): Returned;
+
+export function matchResult<Value, Returned, E = Error>(
+	result: AnyResult<Value, E> | (() => AnyResult<Value, E>),
+	first: ResultMatch<Value, Returned, E> | ResultMatch<Value, Returned, E>['ok'],
+	error?: ResultMatch<Value, Returned, E>['error'],
+): Returned {
+	const value = typeof result === 'function' ? result() : result;
+
+	if (!isResult(value)) {
+		throw new Error(MESSAGE_RESULT);
+	}
+
+	const hasObj = typeof first === 'object' && first !== null;
+
+	const okHandler = hasObj ? first.ok : first;
+	const errorHandler = hasObj ? first.error : error;
+
+	if (isOk(value)) {
+		return okHandler(value.value);
+	}
+
+	return errorHandler!(value.error, (value as ExtendedErr<E>).original);
+}
+
+matchResult.async = asyncMatchResult;
+
+// #endregion
+
+// #region Variables
+
+const MESSAGE_RESULT = '`result.match` expected a Result or a function that returns a Result';
+
+// #endregion

package/src/result/models.ts

@@ -2,6 +2,11 @@ import type {GenericCallback} from '../models';
 
 // #region Types
 
+/**
+ * An unknown result
+ */
+export type AnyResult<Value, E> = Err<E> | ExtendedErr<E> | Ok<Value>;
+
 /**
  * An error result
  */
@@ -35,6 +40,25 @@ export type Ok<Value> = {
  */
 export type Result<Value, E = Error> = Err<E> | Ok<Value>;
 
+/**
+ * Match callbacks for a result
+ */
+export type ResultMatch<Value, Returned, E = Error> = {
+	/**
+	 * Callback for error result
+	 * @param error Error value
+	 * @param original Original error, if available
+	 * @returns Value to return
+	 */
+	error: (error: E, original?: Error) => Returned;
+	/**
+	 * Callback for ok result
+	 * @param value Ok value
+	 * @returns Value to return
+	 */
+	ok: (value: Value) => Returned;
+};
+
 /**
  * Unwrap a result value
  */

package/types/result/index.d.ts

@@ -1,4 +1,5 @@
 import { attemptPromise } from '../promise';
+import { matchResult } from './match';
 import type { Err, ExtendedErr, ExtendedResult, Ok, Result } from './models';
 import { attemptFlow } from './work/flow';
 import { attemptPipe } from './work/pipe';
@@ -34,7 +35,7 @@ declare function asyncAttempt<Value>(callback: () => Promise<Value>): Promise<Re
  * @param error Error value
  * @returns Callback result
  */
-export declare function attempt<Value, E>(callback: () => Value, error: E): ExtendedErr<E> | Ok<Value>;
+export declare function attempt<Value, E>(callback: () => Value, error: E): ExtendedResult<Value, E>;
 /**
  * Executes a callback, catching any errors, and returns a result
  * @param callback Callback to execute
@@ -44,6 +45,7 @@ export declare function attempt<Value>(callback: () => Value): Result<Value, Err
 export declare namespace attempt {
     var async: typeof asyncAttempt;
     var flow: typeof attemptFlow;
+    var match: typeof matchResult;
     var pipe: typeof attemptPipe;
     var promise: typeof attemptPromise;
 }

package/types/result/match.d.ts

@@ -0,0 +1,31 @@
+import type { AnyResult, ResultMatch } from './models';
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param handler Match callbacks
+ */
+declare function asyncMatchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>), handler: ResultMatch<Value, Returned, E>): Promise<Returned>;
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param ok Ok callback
+ * @param error Error callback
+ */
+declare function asyncMatchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>), ok: ResultMatch<Value, Returned, E>['ok'], error: ResultMatch<Value, Returned, E>['error']): Promise<Returned>;
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param handler Match callbacks
+ */
+export declare function matchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | (() => AnyResult<Value, E>), handler: ResultMatch<Value, Returned, E>): Returned;
+/**
+ * Handles a result with match callbacks
+ * @param result Result to handle
+ * @param ok Ok callback
+ * @param error Error callback
+ */
+export declare function matchResult<Value, Returned, E = Error>(result: AnyResult<Value, E> | (() => AnyResult<Value, E>), ok: ResultMatch<Value, Returned, E>['ok'], error: ResultMatch<Value, Returned, E>['error']): Returned;
+export declare namespace matchResult {
+    var async: typeof asyncMatchResult;
+}
+export {};

package/types/result/models.d.ts

@@ -1,4 +1,8 @@
 import type { GenericCallback } from '../models';
+/**
+ * An unknown result
+ */
+export type AnyResult<Value, E> = Err<E> | ExtendedErr<E> | Ok<Value>;
 /**
  * An error result
  */
@@ -27,6 +31,24 @@ export type Ok<Value> = {
  * An unknown result
  */
 export type Result<Value, E = Error> = Err<E> | Ok<Value>;
+/**
+ * Match callbacks for a result
+ */
+export type ResultMatch<Value, Returned, E = Error> = {
+    /**
+     * Callback for error result
+     * @param error Error value
+     * @param original Original error, if available
+     * @returns Value to return
+     */
+    error: (error: E, original?: Error) => Returned;
+    /**
+     * Callback for ok result
+     * @param value Ok value
+     * @returns Value to return
+     */
+    ok: (value: Value) => Returned;
+};
 /**
  * Unwrap a result value
  */