@oscarpalmer/atoms 0.186.2 → 0.187.0

package/src/result/match.ts

@@ -4,11 +4,13 @@ import type {AnyResult, ExtendedErr, ResultMatch} from './models';
 // #region Functions
 
 /**
- * Handles a result with match callbacks
+ * Handles a _Result_ with match callbacks
  *
- * Available as `asyncMatchResult` and `matchResult.async`
- * @param result Result to handle
+ * _Available as `asyncMatchResult` and `matchResult.async`_
+ *
+ * @param result _Result_ to handle
  * @param handler Match callbacks
+ * @returns Matched value-_Promise_
  */
 export async function asyncMatchResult<Value, Returned, E = Error>(
 	result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>),
@@ -16,12 +18,14 @@ export async function asyncMatchResult<Value, Returned, E = Error>(
 ): Promise<Returned>;
 
 /**
- * Handles a result with match callbacks
+ * Handles a _Result_ with match callbacks
+ *
+ * _Available as `asyncMatchResult` and `matchResult.async`_
  *
- * Available as `asyncMatchResult` and `matchResult.async`
- * @param result Result to handle
+ * @param result _Result_ to handle
  * @param ok Ok callback
  * @param error Error callback
+ * @returns Matched value-_Promise_
  */
 export async function asyncMatchResult<Value, Returned, E = Error>(
 	result: AnyResult<Value, E> | Promise<AnyResult<Value, E>> | (() => Promise<AnyResult<Value, E>>),
@@ -61,9 +65,11 @@ export async function asyncMatchResult<Value, Returned, E = Error>(
 }
 
 /**
- * Handles a result with match callbacks
- * @param result Result to handle
+ * Handles a _Result_ with match callbacks
+ *
+ * @param result _Result_ to handle
  * @param handler Match callbacks
+ * @returns Matched value
  */
 export function matchResult<Value, Returned, E = Error>(
 	result: AnyResult<Value, E> | (() => AnyResult<Value, E>),
@@ -71,10 +77,12 @@ export function matchResult<Value, Returned, E = Error>(
 ): Returned;
 
 /**
- * Handles a result with match callbacks
- * @param result Result to handle
+ * Handles a _Result_ with match callbacks
+ *
+ * @param result _Result_ to handle
  * @param ok Ok callback
  * @param error Error callback
+ * @returns Matched value
  */
 export function matchResult<Value, Returned, E = Error>(
 	result: AnyResult<Value, E> | (() => AnyResult<Value, E>),

package/src/result/misc.ts

@@ -5,6 +5,7 @@ import type {AnyResult, Err, ExtendedErr, Ok, Result} from './models';
 
 /**
  * Creates an extended error result
+ *
  * @param value Error value
  * @param original Original error
  * @returns Error result
@@ -13,6 +14,7 @@ export function error<E>(value: E, original: Error): ExtendedErr<E>;
 
 /**
  * Creates an error result
+ *
  * @param value Error value
  * @returns Error result
  */
@@ -37,6 +39,7 @@ export function getError<E>(value: E, original?: Error): Err<E> | ExtendedErr<E>
 
 /**
  * Creates an ok result
+ *
  * @param value Value
  * @returns Ok result
  */
@@ -48,9 +51,10 @@ export function ok<Value>(value: Value): Ok<Value> {
 }
 
 /**
- * Converts a result to a promise
+ * Converts a result to a _Promise_
  *
  * Resolves if ok, rejects for error
+ *
  * @param callback Callback to get the result
  * @returns Promised result
  */
@@ -59,19 +63,21 @@ export async function toPromise<Value, E = Error>(
 ): Promise<Value>;
 
 /**
- * Converts a result to a promise
+ * Converts a result to a _Promise_
  *
  * Resolves if ok, rejects for error
- * @param result Result to convert
+ *
+ * @param result _Result_ to convert
  * @returns Promised result
  */
 export async function toPromise<Value, E = Error>(result: AnyResult<Value, E>): Promise<Value>;
 
 /**
- * Converts a result to a promise
+ * Converts a _Result_ to a _Promise_
  *
  * Resolves if ok, rejects for error
- * @param result Result to convert
+ *
+ * @param result _Result_ to convert
  * @returns Promised result
  */
 export async function toPromise<Value, E = Error>(
@@ -88,17 +94,19 @@ export async function toPromise<Value, E = Error>(
 
 /**
  * Gets the value of an ok result _(or a default value)_
- * @param value Result to unwrap
+ *
+ * @param value _Result_ to unwrap
  * @param defaultValue Default value
- * @returns Value of the result _(or the default value)_
+ * @returns Value of the _Result_ _(or the default value)_
  */
 export function unwrap<Value, E = Error>(value: Result<Value, E>, defaultValue: Value): Value;
 
 /**
  * Gets the value of an ok result _(or a default value)_
- * @param value Result to unwrap
+ *
+ * @param value _Result_ to unwrap
  * @param defaultValue Default value
- * @returns Value of the result _(or the default value)_
+ * @returns Value of the _Result_ _(or the default value)_
  */
 export function unwrap(value: unknown, defaultValue: unknown): unknown;
 

package/src/result/models.ts

@@ -46,6 +46,7 @@ export type Result<Value, E = Error> = Err<E> | Ok<Value>;
 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
@@ -53,6 +54,7 @@ export type ResultMatch<Value, Returned, E = Error> = {
 	error: (error: E, original?: Error) => Returned;
 	/**
 	 * Callback for ok result
+	 *
 	 * @param value Ok value
 	 * @returns Value to return
 	 */

package/src/result/work/flow.ts

@@ -7,14 +7,14 @@ import type {Result, UnwrapValue} from '../models';
 // #region Types
 
 /**
- * A synchronous Flow, a function that attempts to pipe values through a series of functions
+ * A synchronous _Flow_, a function that attempts to pipe values through a series of functions
  */
 export type AttemptFlow<Callback extends GenericCallback, Value> = (
 	...args: Parameters<Callback>
 ) => Result<UnwrapValue<Value>>;
 
 /**
- * An asynchronous Flow, a function that attempts to pipe values through a series of functions
+ * An asynchronous _Flow_, a function that attempts to pipe values through a series of functions
  */
 export type AttemptFlowPromise<Callback extends GenericCallback, Value> = (
 	...args: Parameters<Callback>
@@ -27,20 +27,22 @@ export type AttemptFlowPromise<Callback extends GenericCallback, Value> = (
 // #region Asynchronous
 
 /**
- * Create an asynchronous Flow, a function that attempts to pipe a value through a series of functions
+ * Create an asynchronous _Flow_, a function that attempts to pipe a value through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
+ *
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<Fn extends GenericCallback>(
 	fn: Fn,
 ): AttemptFlowPromise<Fn, ReturnType<Fn>>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second>(
 	first: First,
@@ -48,10 +50,11 @@ export function attemptAsyncFlow<First extends GenericCallback, Second>(
 ): AttemptFlowPromise<First, Second>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second, Third>(
 	first: First,
@@ -60,10 +63,11 @@ export function attemptAsyncFlow<First extends GenericCallback, Second, Third>(
 ): AttemptFlowPromise<First, Third>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
+ *
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth>(
 	first: First,
@@ -73,10 +77,11 @@ export function attemptAsyncFlow<First extends GenericCallback, Second, Third, F
 ): AttemptFlowPromise<First, Fourth>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth>(
 	first: First,
@@ -87,10 +92,11 @@ export function attemptAsyncFlow<First extends GenericCallback, Second, Third, F
 ): AttemptFlowPromise<First, Fifth>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<
 	First extends GenericCallback,
@@ -109,10 +115,11 @@ export function attemptAsyncFlow<
 ): AttemptFlowPromise<First, Sixth>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
+ *
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<
 	First extends GenericCallback,
@@ -133,10 +140,11 @@ export function attemptAsyncFlow<
 ): AttemptFlowPromise<First, Seventh>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<
 	First extends GenericCallback,
@@ -159,10 +167,11 @@ export function attemptAsyncFlow<
 ): AttemptFlowPromise<First, Eighth>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<
 	First extends GenericCallback,
@@ -187,10 +196,11 @@ export function attemptAsyncFlow<
 ): AttemptFlowPromise<First, Ninth>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
+ *
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<
 	First extends GenericCallback,
@@ -217,10 +227,11 @@ export function attemptAsyncFlow<
 ): AttemptFlowPromise<First, Tenth>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow<Fn extends GenericCallback>(
 	fn: Fn,
@@ -228,10 +239,11 @@ export function attemptAsyncFlow<Fn extends GenericCallback>(
 ): AttemptFlowPromise<Fn, ReturnType<Fn>>;
 
 /**
- * Create an asynchronous Flow, a function that pipes values through a series of functions
+ * Create an asynchronous _Flow_, a function that pipes values through a series of functions
+ *
+ * _Available as `attemptAsyncFlow` and `attemptFlow.async`_
  *
- * Available as `attemptAsyncFlow` and `attemptFlow.async`
- * @returns Flow function
+ * @returns _Flow_ function
  */
 export function attemptAsyncFlow(
 	...fns: GenericCallback[]
@@ -263,14 +275,16 @@ export function attemptAsyncFlow(
 // #region Synchronous
 
 /**
- * Create a Flow, a function that attempts to pipe values through a function
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a function
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<Fn extends GenericCallback>(fn: Fn): AttemptFlow<Fn, ReturnType<Fn>>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<First extends GenericCallback, Second>(
 	first: First,
@@ -278,8 +292,9 @@ export function attemptFlow<First extends GenericCallback, Second>(
 ): AttemptFlow<First, Second>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third>(
 	first: First,
@@ -288,8 +303,9 @@ export function attemptFlow<First extends GenericCallback, Second, Third>(
 ): AttemptFlow<First, Third>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third, Fourth>(
 	first: First,
@@ -299,8 +315,9 @@ export function attemptFlow<First extends GenericCallback, Second, Third, Fourth
 ): AttemptFlow<First, Fourth>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth>(
 	first: First,
@@ -311,8 +328,9 @@ export function attemptFlow<First extends GenericCallback, Second, Third, Fourth
 ): AttemptFlow<First, Fifth>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth>(
 	first: First,
@@ -324,8 +342,9 @@ export function attemptFlow<First extends GenericCallback, Second, Third, Fourth
 ): AttemptFlow<First, Sixth>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<
 	First extends GenericCallback,
@@ -346,8 +365,9 @@ export function attemptFlow<
 ): AttemptFlow<First, Seventh>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<
 	First extends GenericCallback,
@@ -370,8 +390,9 @@ export function attemptFlow<
 ): AttemptFlow<First, Eighth>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<
 	First extends GenericCallback,
@@ -396,8 +417,9 @@ export function attemptFlow<
 ): AttemptFlow<First, Ninth>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<
 	First extends GenericCallback,
@@ -424,8 +446,9 @@ export function attemptFlow<
 ): AttemptFlow<First, Tenth>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow<First extends GenericCallback>(
 	first: First,
@@ -433,8 +456,9 @@ export function attemptFlow<First extends GenericCallback>(
 ): AttemptFlow<First, ReturnType<First>>;
 
 /**
- * Create a Flow, a function that attempts to pipe values through a series of functions
- * @returns Flow function
+ * Create a _Flow_, a function that attempts to pipe values through a series of functions
+ *
+ * @returns _Flow_ function
  */
 export function attemptFlow(...fns: GenericCallback[]): (...args: unknown[]) => Result<unknown>;