@oscarpalmer/atoms 0.184.2 → 0.185.0

package/src/result/work/flow.ts

@@ -29,7 +29,7 @@ export type AttemptFlowPromise<Callback extends GenericCallback, Value> = (
 /**
  * Create an asynchronous Flow, a function that attempts to pipe a value through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<Fn extends GenericCallback>(
@@ -39,7 +39,7 @@ export function attemptAsyncFlow<Fn extends GenericCallback>(
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second>(
@@ -50,7 +50,7 @@ export function attemptAsyncFlow<First extends GenericCallback, Second>(
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second, Third>(
@@ -62,7 +62,7 @@ export function attemptAsyncFlow<First extends GenericCallback, Second, Third>(
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth>(
@@ -75,7 +75,7 @@ export function attemptAsyncFlow<First extends GenericCallback, Second, Third, F
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<First extends GenericCallback, Second, Third, Fourth, Fifth>(
@@ -89,7 +89,7 @@ export function attemptAsyncFlow<First extends GenericCallback, Second, Third, F
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<
@@ -111,7 +111,7 @@ export function attemptAsyncFlow<
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<
@@ -135,7 +135,7 @@ export function attemptAsyncFlow<
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<
@@ -161,7 +161,7 @@ export function attemptAsyncFlow<
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<
@@ -189,7 +189,7 @@ export function attemptAsyncFlow<
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<
@@ -219,7 +219,7 @@ export function attemptAsyncFlow<
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow<Fn extends GenericCallback>(
@@ -230,7 +230,7 @@ export function attemptAsyncFlow<Fn extends GenericCallback>(
 /**
  * Create an asynchronous Flow, a function that pipes values through a series of functions
  *
- * Available as `attemptAsyncFlow` and `attempt.flow.async`
+ * Available as `attemptAsyncFlow` and `attemptFlow.async`
  * @returns Flow function
  */
 export function attemptAsyncFlow(
@@ -264,16 +264,12 @@ export function attemptAsyncFlow(
 
 /**
  * Create a Flow, a function that attempts to pipe values through a function
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @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
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<First extends GenericCallback, Second>(
@@ -283,8 +279,6 @@ export function attemptFlow<First extends GenericCallback, Second>(
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third>(
@@ -295,8 +289,6 @@ export function attemptFlow<First extends GenericCallback, Second, Third>(
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third, Fourth>(
@@ -308,8 +300,6 @@ export function attemptFlow<First extends GenericCallback, Second, Third, Fourth
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth>(
@@ -322,8 +312,6 @@ export function attemptFlow<First extends GenericCallback, Second, Third, Fourth
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<First extends GenericCallback, Second, Third, Fourth, Fifth, Sixth>(
@@ -337,8 +325,6 @@ export function attemptFlow<First extends GenericCallback, Second, Third, Fourth
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<
@@ -361,8 +347,6 @@ export function attemptFlow<
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<
@@ -387,8 +371,6 @@ export function attemptFlow<
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<
@@ -415,8 +397,6 @@ export function attemptFlow<
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<
@@ -445,8 +425,6 @@ export function attemptFlow<
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow<First extends GenericCallback>(
@@ -456,8 +434,6 @@ export function attemptFlow<First extends GenericCallback>(
 
 /**
  * Create a Flow, a function that attempts to pipe values through a series of functions
- *
- * Available as `attemptFlow` and `attempt.flow`
  * @returns Flow function
  */
 export function attemptFlow(...fns: GenericCallback[]): (...args: unknown[]) => Result<unknown>;

package/src/result/work/pipe.ts

@@ -17,7 +17,7 @@ type WrapValue<Value> = Result<UnwrapValue<Value>>;
 /**
  * Attempt to pipe a value through a function
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -29,7 +29,7 @@ export async function attemptAsyncPipe<Initial, Piped>(
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -42,7 +42,7 @@ export async function attemptAsyncPipe<Initial, First, Second>(
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -56,7 +56,7 @@ export async function attemptAsyncPipe<Initial, First, Second, Third>(
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -71,7 +71,7 @@ export async function attemptAsyncPipe<Initial, First, Second, Third, Fourth>(
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -87,7 +87,7 @@ export async function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fi
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -104,7 +104,7 @@ export async function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fi
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -131,7 +131,7 @@ export async function attemptAsyncPipe<
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -160,7 +160,7 @@ export async function attemptAsyncPipe<
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -191,7 +191,7 @@ export async function attemptAsyncPipe<
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -224,7 +224,7 @@ export async function attemptAsyncPipe<
 /**
  * Attempt to pipe a result through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial result
  * @returns Piped result
  */
@@ -265,8 +265,6 @@ export async function attemptAsyncPipe(
 
 /**
  * Attempt to pipe a value through a function
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -277,8 +275,6 @@ export function attemptPipe<Initial, Pipe>(
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -290,8 +286,6 @@ export function attemptPipe<Initial, First, Second>(
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -304,8 +298,6 @@ export function attemptPipe<Initial, First, Second, Third>(
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -319,8 +311,6 @@ export function attemptPipe<Initial, First, Second, Third, Fourth>(
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -335,8 +325,6 @@ export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth>(
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -352,8 +340,6 @@ export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth>
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -370,8 +356,6 @@ export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth,
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -389,8 +373,6 @@ export function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth,
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -420,8 +402,6 @@ export function attemptPipe<
 
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -453,8 +433,6 @@ export function attemptPipe<
 
 /**
  * Attempt to pipe a result through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial result
  * @returns Piped result
  */

package/src/sized/set.ts

@@ -1,10 +1,11 @@
 import {getSizedMaximum} from '../internal/sized';
 
-// #region Types and classes
+// #region Types
 
 /**
- * - A Set with a maximum size
- * - Behavior is similar to a _LRU_-cache, where the oldest values are removed
+ * A Set with a maximum size
+ *
+ * Behavior is similar to a _LRU_-cache, where the oldest values are removed
  */
 export class SizedSet<Value = unknown> extends Set<Value> {
 	/**

package/src/value/shake.ts

@@ -3,6 +3,9 @@ import type {PlainObject} from '../models';
 
 // #region Types
 
+/**
+ * A shaken object, without any `undefined` values
+ */
 export type Shaken<Value extends PlainObject> = {
 	[Key in keyof Value]: Value[Key] extends undefined ? never : Value[Key];
 };

package/src/value/smush.ts

@@ -11,6 +11,9 @@ import type {
 
 // #region Types
 
+/**
+ * A smushed object, with all nested objects flattened into a single level, using dot notation keys
+ */
 export type Smushed<Value extends PlainObject> = Simplify<{
 	[NestedKey in NestedKeys<Value>]: NestedValue<Value, ToString<NestedKey>>;
 }>;

package/src/value/transform.ts

@@ -3,15 +3,24 @@ import type {GenericCallback, PlainObject} from '../models';
 
 // #region Types
 
+/**
+ * A callback transform an object's properties
+ */
 type TransformCallback<Value extends PlainObject, Key extends keyof Value> = (
 	key: Key,
 	value: Value[Key],
 ) => Value[Key];
 
+/**
+ * A collection of keyed callbacks to transform an object's properties
+ */
 type TransformCallbacks<Value extends PlainObject> = Partial<{
 	[Key in keyof Value]: (value: Value[Key]) => Value[Key];
 }>;
 
+/**
+ * A transformer function for an object, with predefined callbacks for transforming its properties
+ */
 export type Transformer<Value extends PlainObject> = {
 	(value: Value): Value;
 };

package/src/value/unsmush.ts

@@ -25,6 +25,9 @@ type UnionToIntersection<Union> = (
 	? Intersection & Union
 	: never;
 
+/**
+ * An unsmushed object, with all dot notation keys turned into nested keys
+ */
 export type Unsmushed<Value extends PlainObject> = Simplify<
 	Omit<
 		{