@oscarpalmer/atoms 0.186.2 → 0.187.0

package/dist/result/work/flow.d.mts

@@ -3,155 +3,179 @@ import { Result, UnwrapValue } from "../models.mjs";
 
 //#region src/result/work/flow.d.ts
 /**
- * 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
  */
 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
  */
 type AttemptFlowPromise<Callback extends GenericCallback, Value> = (...args: Parameters<Callback>) => Promise<Result<UnwrapValue<Value>>>;
 /**
- * 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
  */
 declare 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth): 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth, fifth: (value: Awaited<UnwrapValue<Fourth>>) => Fifth): 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth, fifth: (value: Awaited<UnwrapValue<Fourth>>) => Fifth, sixth: (value: Awaited<UnwrapValue<Fifth>>) => Sixth): 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth, fifth: (value: Awaited<UnwrapValue<Fourth>>) => Fifth, sixth: (value: Awaited<UnwrapValue<Fifth>>) => Sixth, seventh: (value: Awaited<UnwrapValue<Sixth>>) => Seventh): 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth, fifth: (value: Awaited<UnwrapValue<Fourth>>) => Fifth, sixth: (value: Awaited<UnwrapValue<Fifth>>) => Sixth, seventh: (value: Awaited<UnwrapValue<Sixth>>) => Seventh, eighth: (value: Awaited<UnwrapValue<Seventh>>) => Eighth): 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth, fifth: (value: Awaited<UnwrapValue<Fourth>>) => Fifth, sixth: (value: Awaited<UnwrapValue<Fifth>>) => Sixth, seventh: (value: Awaited<UnwrapValue<Sixth>>) => Seventh, eighth: (value: Awaited<UnwrapValue<Seventh>>) => Eighth, ninth: (value: Awaited<UnwrapValue<Eighth>>) => Ninth): 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
  */
 declare function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth, Tenth>(first: First, second: (value: Awaited<UnwrapValue<ReturnType<First>>>) => Second, third: (value: Awaited<UnwrapValue<Second>>) => Third, fourth: (value: Awaited<UnwrapValue<Third>>) => Fourth, fifth: (value: Awaited<UnwrapValue<Fourth>>) => Fifth, sixth: (value: Awaited<UnwrapValue<Fifth>>) => Sixth, seventh: (value: Awaited<UnwrapValue<Sixth>>) => Seventh, eighth: (value: Awaited<UnwrapValue<Seventh>>) => Eighth, ninth: (value: Awaited<UnwrapValue<Eighth>>) => Ninth, tenth: (value: Awaited<UnwrapValue<Ninth>>) => Tenth): 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
  */
 declare function attemptAsyncFlow<Fn extends GenericCallback>(fn: Fn, ...fns: Array<(value: Awaited<UnwrapValue<ReturnType<Fn>>>) => unknown>): 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
  */
 declare function attemptAsyncFlow(...fns: GenericCallback[]): (...args: unknown[]) => Promise<Result<unknown>>;
 /**
- * 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
  */
 declare 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
  */
 declare function attemptFlow<First extends GenericCallback, Second>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => 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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth): 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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth): 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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh): 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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth): 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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth): 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
  */
 declare function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth, Tenth>(first: First, second: (value: UnwrapValue<ReturnType<First>>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth, tenth: (value: UnwrapValue<Ninth>) => Tenth): 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
  */
 declare function attemptFlow<First extends GenericCallback>(first: First, ...fns: Array<(value: UnwrapValue<ReturnType<First>>) => unknown>): 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
  */
 declare function attemptFlow(...fns: GenericCallback[]): (...args: unknown[]) => Result<unknown>;
 declare namespace attemptFlow {

package/dist/result/work/pipe.d.mts

@@ -6,155 +6,177 @@ type WrapValue<Value> = Result<UnwrapValue<Value>>;
 /**
  * Attempt to pipe a value through a function
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, Piped>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, pipe: (value: UnwrapValue<Initial>) => Piped): Promise<WrapValue<Piped>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second): Promise<WrapValue<Second>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third): Promise<WrapValue<Third>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth): Promise<WrapValue<Fourth>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth): Promise<WrapValue<Fifth>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth): Promise<WrapValue<Sixth>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh): Promise<WrapValue<Seventh>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth): Promise<WrapValue<Eighth>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth): Promise<WrapValue<Ninth>>;
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth, Tenth>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth, tenth: (value: UnwrapValue<Ninth>) => Tenth): Promise<WrapValue<Tenth>>;
 /**
  * Attempt to pipe a result through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attemptPipe.async`
+ * _Available as `attemptAsyncPipe` and `attemptPipe.async`_
+ *
  * @param initial Initial result
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptAsyncPipe<Initial>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first?: (value: UnwrapValue<Initial>) => unknown, ...seconds: Array<(value: unknown) => unknown>): Promise<WrapValue<Initial>>;
 /**
  * Attempt to pipe a value through a function
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, Pipe>(initial: GenericCallback | Initial | Result<Initial>, pipe: (value: UnwrapValue<Initial>) => Pipe): WrapValue<Pipe>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second): WrapValue<Second>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third): WrapValue<Third>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth): WrapValue<Fourth>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth): WrapValue<Fifth>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth): WrapValue<Sixth>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh): WrapValue<Seventh>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth): WrapValue<Eighth>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth): WrapValue<Ninth>;
 /**
  * Attempt to pipe a value through a series of functions
+ *
  * @param initial Initial value
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth, Tenth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth, tenth: (value: UnwrapValue<Ninth>) => Tenth): WrapValue<Tenth>;
 /**
  * Attempt to pipe a result through a series of functions
+ *
  * @param initial Initial result
- * @returns Piped result
+ * @returns _Piped_ result
  */
 declare function attemptPipe<Initial>(initial: GenericCallback | Initial | Result<Initial>, first?: (value: UnwrapValue<Initial>) => unknown, ...seconds: Array<(value: unknown) => unknown>): WrapValue<Initial>;
 declare namespace attemptPipe {

package/dist/sized/map.d.mts

@@ -1,36 +1,39 @@
 //#region src/sized/map.d.ts
 /**
- * A Map with a maximum size
+ * A _Map_ with a maximum size
  *
- * Behavior is similar to a _LRU_-cache, where the least recently used entries are removed
+ * Behavior is similar to a _LRU_ cache, where the least recently used entries are removed
  */
 declare class SizedMap<SizedKey = unknown, SizedValue = unknown> extends Map<SizedKey, SizedValue> {
   #private;
   /**
-   * Is the Map full?
+   * Is the _Map_ full?
    */
   get full(): boolean;
   get maximum(): number;
   /**
-   * Create a new SizedMap with entries and a maximum size _(2^20)_
-   * @param entries Array of key-value pairs to initialize the SizedMap with
-   * @template SizedKey Type of the keys in the SizedMap
-   * @template SizedValue Type of the values in the SizedMap
+   * Create a new _SizedMap_ with entries and a maximum size _(2^20)_
+   *
+   * @param entries Array of key-value pairs to initialize the _SizedMap_ with
+   * @template SizedKey Type of the keys in the _SizedMap_
+   * @template SizedValue Type of the values in the _SizedMap_
    */
   constructor(entries: [SizedKey, SizedValue][]);
   /**
-   * Create a new SizedMap with a maximum size _(but clamped at 2^24)_
-   * @param maximum Maximum size of the SizedMap
-   * @template SizedKey Type of the keys in the SizedMap
-   * @template SizedValue Type of the values in the SizedMap
+   * Create a new _SizedMap_ with a maximum size _(but clamped at 2^24)_
+   *
+   * @param maximum Maximum size of the _SizedMap_
+   * @template SizedKey Type of the keys in the _SizedMap_
+   * @template SizedValue Type of the values in the _SizedMap_
    */
   constructor(maximum: number);
   /**
-   * Create a new SizedMap with _(optional)_ entries and a maximum size _(defaults to 2^20; clamped at 2^24)_
-   * @param entries Array of key-value pairs to initialize the SizedMap with
-   * @param maximum Maximum size of the SizedMap
-   * @template SizedKey Type of the keys in the SizedMap
-   * @template SizedValue Type of the values in the SizedMap
+   * Create a new _SizedMap_ with _(optional)_ entries and a maximum size
+   *
+   * @param entries Array of key-value pairs to initialize the _SizedMap_ with
+   * @param maximum Maximum size of the _SizedMap_ _(defaults to 2^20; clamped at 2^24)_
+   * @template SizedKey Type of the keys in the _SizedMap_
+   * @template SizedValue Type of the values in the _SizedMap_
    */
   constructor(entries?: [SizedKey, SizedValue][], maximum?: number);
   /**

package/dist/sized/map.mjs

@@ -1,17 +1,17 @@
 import { getSizedMaximum } from "../internal/sized.mjs";
 //#region src/sized/map.ts
 /**
-* A Map with a maximum size
+* A _Map_ with a maximum size
 *
-* Behavior is similar to a _LRU_-cache, where the least recently used entries are removed
+* Behavior is similar to a _LRU_ cache, where the least recently used entries are removed
 */
 var SizedMap = class extends Map {
 	/**
-	* The maximum size of the Map
+	* The maximum size of the _Map_
 	*/
 	#maximumSize;
 	/**
-	* Is the Map full?
+	* Is the _Map_ full?
 	*/
 	get full() {
 		return super.size >= this.#maximumSize;

package/dist/sized/set.d.mts

@@ -1,33 +1,36 @@
 //#region src/sized/set.d.ts
 /**
- * A Set with a maximum size
+ * A _Set_ with a maximum size
  *
- * Behavior is similar to a _LRU_-cache, where the oldest values are removed
+ * Behavior is similar to a _LRU_ cache, where the oldest values are removed
  */
 declare class SizedSet<Value = unknown> extends Set<Value> {
   #private;
   /**
-   * Is the Set full?
+   * Is the _Set_ full?
    */
   get full(): boolean;
   get maximum(): number;
   /**
-   * Create a new SizedSet with values and a maximum size _(2^20)_
-   * @param values Array of values to initialize the SizedSet with
-   * @template Value Type of the values in the SizedSet
+   * Create a new _SizedSet_ with values and a maximum size _(2^20)_
+   *
+   * @param values Array of values to initialize the _SizedSet_ with
+   * @template Value Type of the values in the _SizedSet_
    */
   constructor(values: Value[]);
   /**
-   * Create a new SizedSet with a maximum size _(but clamped at 2^24)_
-   * @param maximum Maximum size of the SizedSet
-   * @template Value Type of the values in the SizedSet
+   * Create a new _SizedSet_ with a maximum size _(but clamped at 2^24)_
+   *
+   * @param maximum Maximum size of the _SizedSet_ _(defaults to 2^20; clamped at 2^24)_
+   * @template Value Type of the values in the _SizedSet_
    */
   constructor(maximum: number);
   /**
-   * Create a new SizedSet with _(optional)_ values and a maximum size _(defaults to 2^20; clamped at 2^24)_
-   * @param values Array of values to initialize the SizedSet with
-   * @param maximum Maximum size of the SizedSet
-   * @template Value Type of the values in the SizedSet
+   * Create a new _SizedSet_ with _(optional)_ values and a maximum size
+   *
+   * @param values Array of values to initialize the _SizedSet_ with
+   * @param maximum Maximum size of the _SizedSet_ _(defaults to 2^20; clamped at 2^24)_
+   * @template Value Type of the values in the _SizedSet_
    */
   constructor(values?: Value[], maximum?: number);
   /**
@@ -35,9 +38,10 @@ declare class SizedSet<Value = unknown> extends Set<Value> {
    */
   add(value: Value): this;
   /**
-   * Get a value from the SizedSet, if it exists _(and move it to the end)_
-   * @param value Value to get from the SizedSet
-   * @param update Update the value's position in the SizedSet? _(defaults to `false`)_
+   * Get a value from the _SizedSet_, if it exists _(and optionally move it to the end)_
+   *
+   * @param value Value to get from the _SizedSet_
+   * @param update Update the value's position in the _SizedSet_? _(defaults to `false`)_
    * @returns Found value if it exists, otherwise `undefined`
    */
   get(value: Value, update?: boolean): Value | undefined;