@oscarpalmer/atoms 0.186.2 → 0.187.0

package/dist/color/space/hsl.mjs

@@ -31,9 +31,12 @@ function hslToHex(hsl, alpha) {
 	return convertRgbToHex(convertHslToRgba(hsl), alpha ?? false);
 }
 /**
-* Convert an HSL(A) color to an RGB color
+* Convert an _HSL(A)_ color to an _RGB_ color
+*
+* _If the value is unable to be converted, a black RGB color will be returned_
+*
+* _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L61_
 *
-* Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L61
 * @param hsl HSL(A) color
 * @returns RGB color
 */
@@ -46,9 +49,12 @@ function hslToRgb(hsl) {
 	};
 }
 /**
-* Convert an HSL(A) color to an RGBA color
+* Convert an _HSL(A)_ color to an _RGBA_ color
+*
+* _If the value is unable to be converted, a black RGBA color with an alpha channel (opactiy) of `0` will be returned_
+*
+* _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L61_
 *
-* Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L61
 * @param hsl HSL(A) color
 * @returns RGBA color
 */

package/dist/color/space/rgb.d.mts

@@ -5,26 +5,35 @@ declare function convertRgbToHex(rgb: RGBAColor | RGBColor, alpha: boolean): str
 declare function convertRgbToHsla(value: unknown): HSLAColor;
 declare function getRgbValue(value: Record<keyof RGBColor, unknown>): RGBColor;
 /**
- * Convert an RGB(A) color to a hex color _(with optional alpha channel)_
- * @param rgb RGB(A) color
- * @param alpha Include alpha channel? _(defaults to `false`)_
- * @returns Hex color
+ * Convert an _RGB(A)_ color to a hex color _(with optional alpha channel, i.e., opacity)_
+ *
+ * _If the value is unable to be converted, a black hex color will be returned_
+ *
+ * @param rgb _RGB(A)_ color
+ * @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
+ * @returns Hex color string
  */
 declare function rgbToHex(rgb: RGBAColor | RGBColor, alpha?: boolean): string;
 /**
- * Convert an RGB(A) color to an HSL color
+ * Convert an _RGB(A)_ color to an _HSL_ color
+ *
+ * _If the value is unable to be converted, a black HSL color will be returned_
  *
- * Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26
- * @param rgb RGB(A) color
- * @returns HSL color
+ * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
+ *
+ * @param rgb _RGB(A)_ color
+ * @returns _HSL_ color
  */
 declare function rgbToHsl(rgb: RGBAColor | RGBColor): HSLColor;
 /**
- * Convert an RGB(A) color to an HSLA color
+ * Convert an _RGB(A)_ color to an _HSLA_ color
+ *
+ * _If the value is unable to be converted, a black _HSLA_ color with an alpha channel (opacity) of `0` will be returned_
+ *
+ * _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
  *
- * Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26
- * @param rgb RGB(A) color
- * @returns HSLA color
+ * @param rgb _RGB(A)_ color
+ * @returns _HSLA_ color
  */
 declare function rgbToHsla(rgb: RGBAColor | RGBColor): HSLAColor;
 //#endregion

package/dist/color/space/rgb.mjs

@@ -58,20 +58,26 @@ function getRgbValue(value) {
 	};
 }
 /**
-* Convert an RGB(A) color to a hex color _(with optional alpha channel)_
-* @param rgb RGB(A) color
-* @param alpha Include alpha channel? _(defaults to `false`)_
-* @returns Hex color
+* Convert an _RGB(A)_ color to a hex color _(with optional alpha channel, i.e., opacity)_
+*
+* _If the value is unable to be converted, a black hex color will be returned_
+*
+* @param rgb _RGB(A)_ color
+* @param alpha Include alpha channel _(opacity)_? _(defaults to `false`)_
+* @returns Hex color string
 */
 function rgbToHex(rgb, alpha) {
 	return convertRgbToHex(isRgbLike(rgb) ? getRgbValue(rgb) : { ...DEFAULT_RGB }, alpha ?? false);
 }
 /**
-* Convert an RGB(A) color to an HSL color
+* Convert an _RGB(A)_ color to an _HSL_ color
+*
+* _If the value is unable to be converted, a black HSL color will be returned_
 *
-* Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26
-* @param rgb RGB(A) color
-* @returns HSL color
+* _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
+*
+* @param rgb _RGB(A)_ color
+* @returns _HSL_ color
 */
 function rgbToHsl(rgb) {
 	const { hue, lightness, saturation } = convertRgbToHsla(rgb);
@@ -82,11 +88,14 @@ function rgbToHsl(rgb) {
 	};
 }
 /**
-* Convert an RGB(A) color to an HSLA color
+* Convert an _RGB(A)_ color to an _HSLA_ color
+*
+* _If the value is unable to be converted, a black _HSLA_ color with an alpha channel (opacity) of `0` will be returned_
+*
+* _Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26_
 *
-* Thanks, https://github.com/color-js/color.js/blob/main/src/spaces/hsl.js#L26
-* @param rgb RGB(A) color
-* @returns HSLA color
+* @param rgb _RGB(A)_ color
+* @returns _HSLA_ color
 */
 function rgbToHsla(rgb) {
 	return convertRgbToHsla(rgb);

package/dist/function/assert.d.mts

@@ -2,7 +2,7 @@ import { Constructor, NestedKeys, NestedValue, PlainObject } from "../models.mjs
 
 //#region src/function/assert.d.ts
 /**
- * Asserter for a nested property of a value
+ * Asserter for a property of a value
  */
 type AssertProperty<Value extends PlainObject, Path extends NestedKeys<Value>, Asserted extends NestedPick<Value, Path> = NestedPick<Value, Path>> = Asserter<Asserted>;
 /**
@@ -12,6 +12,7 @@ type Asserter<Value> = (value: unknown) => asserts value is Value;
 type NestedPick<Value, Path extends string> = Value extends PlainObject ? Path extends `${infer Head}.${infer Rest}` ? Head extends keyof Value ? { [Key in Head]: NestedPick<Value[Key], Rest> } : never : Path extends keyof Value ? { [Key in Path]: Value[Key] } : never : never;
 /**
  * Asserts that a condition is true, throwing an error if it is not
+ *
  * @param condition Condition to assert
  * @param message Error message
  * @param error Error constructor _(defaults to `Error`)_
@@ -25,53 +26,58 @@ declare namespace assert {
   var property: typeof assertProperty;
 }
 /**
- * Creates an asserter that asserts a condition is true, throwing an error if it is not
+ * Creates an _Asserter_ that asserts a condition is true, throwing an error if it is not
+ *
+ * _Available as `assertCondition` and `assert.condition`_
  *
- * Available as `assertCondition` and `assert.condition`
  * @param condition Condition to assert
  * @param message Error message
  * @param error Error constructor _(defaults to `Error`)_
- * @returns Asserter
+ * @returns _Asserter_
  */
 declare function assertCondition<Value>(condition: (value: unknown) => boolean, message: string, error?: ErrorConstructor): Asserter<Value>;
 /**
  * Asserts that a value is defined, throwing an error if it is not
  *
- * Available as `assertDefined` and `assert.defined`
+ * _Available as `assertDefined` and `assert.defined`_
+ *
  * @param value Value to assert
  * @param message Error message
  * @param error Error constructor _(defaults to `Error`)_
  */
 declare function assertDefined<Value>(value: unknown, message?: string, error?: ErrorConstructor): asserts value is Exclude<Value, null | undefined>;
 /**
- * Creates an asserter that asserts a value is an instance of a constructor, throwing an error if it is not
+ * Creates an _Asserter_ that asserts a value is an instance of a constructor, throwing an error if it is not
+ *
+ * _Available as `assertInstanceOf` and `assert.instanceOf`_
  *
- * Available as `assertInstanceOf` and `assert.instanceOf`
  * @param constructor Constructor to check against
  * @param message Error message
  * @param error Error constructor _(defaults to `Error`)_
- * @returns Asserter
+ * @returns _Asserter_
  */
 declare function assertInstanceOf<Value>(constructor: Constructor<Value>, message: string, error?: ErrorConstructor): Asserter<Value>;
 /**
- * Creates an asserter that asserts a value is of a specific type, throwing an error if it is not
+ * Creates an _Asserter_ that asserts a value is of a specific type, throwing an error if it is not
+ *
+ * _Available as `assertIs` and `assert.is`_
  *
- * Available as `assertIs` and `assert.is`
  * @param condition Type guard function to check the value
  * @param message Error message
  * @param error Error constructor _(defaults to `Error`)_
- * @returns Asserter
+ * @returns _Asserter_
  */
 declare function assertIs<Value>(condition: (value: unknown) => value is Value, message: string, error?: ErrorConstructor): Asserter<Value>;
 /**
- * Creates an asserter that asserts a property of a value exists and satisfies a condition, throwing an error if it does not
+ * Creates an _Asserter_ that asserts a property of a value exists and satisfies a condition, throwing an error if it does not
+ *
+ * _Available as `assertProperty` and `assert.property`_
  *
- * Available as `assertProperty` and `assert.property`
  * @param path Path to the property to check, e.g., `foo.bar.baz` for a nested property
  * @param condition Condition to assert for the property
  * @param message Error message
  * @param error Error constructor _(defaults to `Error`)_
- * @returns Asserter
+ * @returns _Asserter_
  */
 declare function assertProperty<Value extends PlainObject, Path extends NestedKeys<Value>, Asserted = NestedPick<Value, Path>>(path: Path, condition: (value: NestedValue<Value, Path>) => boolean, message: string, error?: ErrorConstructor): Asserter<Asserted>;
 //#endregion

package/dist/function/assert.mjs

@@ -2,6 +2,7 @@ import { hasValueResult } from "../internal/value/has.mjs";
 //#region src/function/assert.ts
 /**
 * Asserts that a condition is true, throwing an error if it is not
+*
 * @param condition Condition to assert
 * @param message Error message
 * @param error Error constructor _(defaults to `Error`)_
@@ -15,13 +16,14 @@ assert.instanceOf = assertInstanceOf;
 assert.is = assertIs;
 assert.property = assertProperty;
 /**
-* Creates an asserter that asserts a condition is true, throwing an error if it is not
+* Creates an _Asserter_ that asserts a condition is true, throwing an error if it is not
+*
+* _Available as `assertCondition` and `assert.condition`_
 *
-* Available as `assertCondition` and `assert.condition`
 * @param condition Condition to assert
 * @param message Error message
 * @param error Error constructor _(defaults to `Error`)_
-* @returns Asserter
+* @returns _Asserter_
 */
 function assertCondition(condition, message, error) {
 	return (value) => {
@@ -31,7 +33,8 @@ function assertCondition(condition, message, error) {
 /**
 * Asserts that a value is defined, throwing an error if it is not
 *
-* Available as `assertDefined` and `assert.defined`
+* _Available as `assertDefined` and `assert.defined`_
+*
 * @param value Value to assert
 * @param message Error message
 * @param error Error constructor _(defaults to `Error`)_
@@ -40,13 +43,14 @@ function assertDefined(value, message, error) {
 	assert(() => value != null, message ?? MESSAGE_VALUE_DEFINED, error);
 }
 /**
-* Creates an asserter that asserts a value is an instance of a constructor, throwing an error if it is not
+* Creates an _Asserter_ that asserts a value is an instance of a constructor, throwing an error if it is not
+*
+* _Available as `assertInstanceOf` and `assert.instanceOf`_
 *
-* Available as `assertInstanceOf` and `assert.instanceOf`
 * @param constructor Constructor to check against
 * @param message Error message
 * @param error Error constructor _(defaults to `Error`)_
-* @returns Asserter
+* @returns _Asserter_
 */
 function assertInstanceOf(constructor, message, error) {
 	return (value) => {
@@ -54,13 +58,14 @@ function assertInstanceOf(constructor, message, error) {
 	};
 }
 /**
-* Creates an asserter that asserts a value is of a specific type, throwing an error if it is not
+* Creates an _Asserter_ that asserts a value is of a specific type, throwing an error if it is not
+*
+* _Available as `assertIs` and `assert.is`_
 *
-* Available as `assertIs` and `assert.is`
 * @param condition Type guard function to check the value
 * @param message Error message
 * @param error Error constructor _(defaults to `Error`)_
-* @returns Asserter
+* @returns _Asserter_
 */
 function assertIs(condition, message, error) {
 	return (value) => {
@@ -68,14 +73,15 @@ function assertIs(condition, message, error) {
 	};
 }
 /**
-* Creates an asserter that asserts a property of a value exists and satisfies a condition, throwing an error if it does not
+* Creates an _Asserter_ that asserts a property of a value exists and satisfies a condition, throwing an error if it does not
+*
+* _Available as `assertProperty` and `assert.property`_
 *
-* Available as `assertProperty` and `assert.property`
 * @param path Path to the property to check, e.g., `foo.bar.baz` for a nested property
 * @param condition Condition to assert for the property
 * @param message Error message
 * @param error Error constructor _(defaults to `Error`)_
-* @returns Asserter
+* @returns _Asserter_
 */
 function assertProperty(path, condition, message, error) {
 	return (value) => {

package/dist/function/limit.d.mts

@@ -4,11 +4,11 @@ import { AsyncCancelableCallback, CancelableCallback, GenericAsyncCallback, Gene
 /**
  * Debounce a function, ensuring it is only called after `time` milliseconds have passed
  *
- * When called, successful _(finished)_ results will resolve and errors will reject.
+ * - When called, successful _(finished)_ results will resolve and errors will reject
+ * - On subsequent calls, existing calls will be canceled _(rejected)_, the timer reset, and will wait another `time` milliseconds before the new call is made _(and so on...)_
  *
- * On subsequent calls, existing calls will be canceled _(rejected)_, the timer reset, and will wait another `time` milliseconds before the new call is made _(and so on...)_
+ * _Available as `asyncDebounce` and `debounce.async`_
  *
- * Available as `asyncDebounce` and `debounce.async`
  * @param callback Callback to debounce
  * @param time Time in milliseconds to wait before calling the callback _(defaults to `0`; e.g., as soon as possible)_
  * @returns Debounced callback handler with a `cancel` method
@@ -17,11 +17,11 @@ declare function asyncDebounce<Callback extends GenericAsyncCallback | GenericCa
 /**
  * Throttle a function, ensuring it is only called once every `time` milliseconds
  *
- * When called, successful _(finished)_ results will resolve and errors will reject.
+ * - When called, successful _(finished)_ results will resolve and errors will reject
+ * - On subsequent calls, existing calls will be canceled _(rejected)_ and will wait until the next valid time to call the callback again _(and so on...)_
  *
- * On subsequent calls, existing calls will be canceled _(rejected)_ and will wait until the next valid time to call the callback again _(and so on...)_
+ * _Available as `asyncThrottle` and `throttle.async`_
  *
- * Available as `asyncThrottle` and `throttle.async`
  * @param callback Callback to throttle
  * @param time Time in milliseconds to wait before calling the callback again _(defaults to `0`; e.g., as soon as possible)_
  * @returns Throttled callback handler with a `cancel` method
@@ -31,6 +31,7 @@ declare function asyncThrottle<Callback extends GenericAsyncCallback | GenericCa
  * Debounce a function, ensuring it is only called after `time` milliseconds have passed
  *
  * On subsequent calls, the timer is reset and will wait another `time` milliseconds _(and so on...)_
+ *
  * @param callback Callback to debounce
  * @param time Time in milliseconds to wait before calling the callback _(defaults to `0`; e.g., as soon as possible)_
  * @returns Debounced callback handler with a `cancel` method
@@ -41,6 +42,7 @@ declare namespace debounce {
 }
 /**
  * Throttle a function, ensuring it is only called once every `time` milliseconds
+ *
  * @param callback Callback to throttle
  * @param time Time in milliseconds to wait before calling the callback again _(defaults to `0`; e.g., as soon as possible)_
  * @returns Throttled callback handler with a `cancel` method

package/dist/function/limit.mjs

@@ -3,11 +3,11 @@ import { TIMER_DEBOUNCE, TIMER_THROTTLE, getAsyncTimer, getTimer } from "../inte
 /**
 * Debounce a function, ensuring it is only called after `time` milliseconds have passed
 *
-* When called, successful _(finished)_ results will resolve and errors will reject.
+* - When called, successful _(finished)_ results will resolve and errors will reject
+* - On subsequent calls, existing calls will be canceled _(rejected)_, the timer reset, and will wait another `time` milliseconds before the new call is made _(and so on...)_
 *
-* On subsequent calls, existing calls will be canceled _(rejected)_, the timer reset, and will wait another `time` milliseconds before the new call is made _(and so on...)_
+* _Available as `asyncDebounce` and `debounce.async`_
 *
-* Available as `asyncDebounce` and `debounce.async`
 * @param callback Callback to debounce
 * @param time Time in milliseconds to wait before calling the callback _(defaults to `0`; e.g., as soon as possible)_
 * @returns Debounced callback handler with a `cancel` method
@@ -18,11 +18,11 @@ function asyncDebounce(callback, time) {
 /**
 * Throttle a function, ensuring it is only called once every `time` milliseconds
 *
-* When called, successful _(finished)_ results will resolve and errors will reject.
+* - When called, successful _(finished)_ results will resolve and errors will reject
+* - On subsequent calls, existing calls will be canceled _(rejected)_ and will wait until the next valid time to call the callback again _(and so on...)_
 *
-* On subsequent calls, existing calls will be canceled _(rejected)_ and will wait until the next valid time to call the callback again _(and so on...)_
+* _Available as `asyncThrottle` and `throttle.async`_
 *
-* Available as `asyncThrottle` and `throttle.async`
 * @param callback Callback to throttle
 * @param time Time in milliseconds to wait before calling the callback again _(defaults to `0`; e.g., as soon as possible)_
 * @returns Throttled callback handler with a `cancel` method
@@ -34,6 +34,7 @@ function asyncThrottle(callback, time) {
 * Debounce a function, ensuring it is only called after `time` milliseconds have passed
 *
 * On subsequent calls, the timer is reset and will wait another `time` milliseconds _(and so on...)_
+*
 * @param callback Callback to debounce
 * @param time Time in milliseconds to wait before calling the callback _(defaults to `0`; e.g., as soon as possible)_
 * @returns Debounced callback handler with a `cancel` method
@@ -44,6 +45,7 @@ function debounce(callback, time) {
 debounce.async = asyncDebounce;
 /**
 * Throttle a function, ensuring it is only called once every `time` milliseconds
+*
 * @param callback Callback to throttle
 * @param time Time in milliseconds to wait before calling the callback again _(defaults to `0`; e.g., as soon as possible)_
 * @returns Throttled callback handler with a `cancel` method

package/dist/function/memoize.d.mts

@@ -2,16 +2,20 @@ import { GenericCallback } from "../models.mjs";
 
 //#region src/function/memoize.d.ts
 /**
- * A memoized function, caching and retrieving results based on the its parameters _(or a custom cache key)_
+ * A _Memoized_ function instance, caching and retrieving results based on the its parameters _(or a custom cache key)_
  */
 declare class Memoized<Callback extends GenericCallback> {
   #private;
   /**
    * Maximum cache size
+   *
+   * @returns Maximum cache size _(or `Number.NaN` if the instance has been destroyed)_
    */
   get maximum(): number;
   /**
    * Current cache size
+   *
+   * @returns Current cache size _(or `Number.NaN` if the instance has been destroyed)_
    */
   get size(): number;
   constructor(callback: Callback, options: Options);
@@ -21,35 +25,41 @@ declare class Memoized<Callback extends GenericCallback> {
   clear(): void;
   /**
    * Delete a result from the cache
+   *
    * @param key Key to delete
    * @returns `true` if the key existed and was removed, otherwise `false`
    */
   delete(key: unknown): boolean;
   /**
-   * Destroy the instance _(clearing its cache and removing its callback)_
+   * Destroy the instance
+   *
+   * _(When a Memoized instance is destroyed, its cache and callback are removed, and calls to `run` will throw an error)_
    */
   destroy(): void;
   /**
    * Get a result from the cache
+   *
    * @param key Key to get
    * @returns Cached result or `undefined` if it does not exist
    */
   get(key: unknown): ReturnType<Callback> | undefined;
   /**
    * Does the result exist?
+   *
    * @param key Key to check
    * @returns `true` if the result exists, otherwise `false`
    */
   has(key: unknown): boolean;
   /**
    * Run the callback with the provided parameters
+   *
    * @param parameters Parameters to pass to the callback
    * @returns Cached or computed _(then cached)_ result
    */
   run(...parameters: Parameters<Callback>): ReturnType<Callback>;
 }
 /**
- * Options for memoized functions
+ * Options for a _Memoized_ function
  */
 type MemoizedOptions<Callback extends GenericCallback> = {
   /**
@@ -67,9 +77,10 @@ type Options = {
 };
 /**
  * Memoize a function, caching and retrieving results based on the first parameter
+ *
  * @param callback Callback to memoize
  * @param options Memoization options
- * @returns Memoized instance
+ * @returns _Memoized_ instance
  */
 declare function memoize<Callback extends GenericCallback>(callback: Callback, options?: MemoizedOptions<Callback>): Memoized<Callback>;
 //#endregion

package/dist/function/memoize.mjs

@@ -3,18 +3,22 @@ import { getString, join } from "../internal/string.mjs";
 import { SizedMap } from "../sized/map.mjs";
 //#region src/function/memoize.ts
 /**
-* A memoized function, caching and retrieving results based on the its parameters _(or a custom cache key)_
+* A _Memoized_ function instance, caching and retrieving results based on the its parameters _(or a custom cache key)_
 */
 var Memoized = class {
 	#state;
 	/**
 	* Maximum cache size
+	*
+	* @returns Maximum cache size _(or `Number.NaN` if the instance has been destroyed)_
 	*/
 	get maximum() {
 		return this.#state.cache?.maximum ?? NaN;
 	}
 	/**
 	* Current cache size
+	*
+	* @returns Current cache size _(or `Number.NaN` if the instance has been destroyed)_
 	*/
 	get size() {
 		return this.#state.cache?.size ?? NaN;
@@ -41,6 +45,7 @@ var Memoized = class {
 	}
 	/**
 	* Delete a result from the cache
+	*
 	* @param key Key to delete
 	* @returns `true` if the key existed and was removed, otherwise `false`
 	*/
@@ -48,7 +53,9 @@ var Memoized = class {
 		return this.#state.cache?.delete(key) ?? false;
 	}
 	/**
-	* Destroy the instance _(clearing its cache and removing its callback)_
+	* Destroy the instance
+	*
+	* _(When a Memoized instance is destroyed, its cache and callback are removed, and calls to `run` will throw an error)_
 	*/
 	destroy() {
 		this.#state.cache?.clear();
@@ -57,6 +64,7 @@ var Memoized = class {
 	}
 	/**
 	* Get a result from the cache
+	*
 	* @param key Key to get
 	* @returns Cached result or `undefined` if it does not exist
 	*/
@@ -65,6 +73,7 @@ var Memoized = class {
 	}
 	/**
 	* Does the result exist?
+	*
 	* @param key Key to check
 	* @returns `true` if the result exists, otherwise `false`
 	*/
@@ -73,11 +82,12 @@ var Memoized = class {
 	}
 	/**
 	* Run the callback with the provided parameters
+	*
 	* @param parameters Parameters to pass to the callback
 	* @returns Cached or computed _(then cached)_ result
 	*/
 	run(...parameters) {
-		if (this.#state.cache == null || this.#state.getter == null) throw new Error("The Memoized instance has been destroyed");
+		if (this.#state.cache == null || this.#state.getter == null) throw new Error(MEMOIZED_ERROR_DESTROYED);
 		return this.#state.getter(...parameters);
 	}
 };
@@ -90,14 +100,18 @@ function getMemoizationOptions(input) {
 }
 /**
 * Memoize a function, caching and retrieving results based on the first parameter
+*
 * @param callback Callback to memoize
 * @param options Memoization options
-* @returns Memoized instance
+* @returns _Memoized_ instance
 */
 function memoize(callback, options) {
+	if (typeof callback !== "function") throw new TypeError(MEMOIZED_ERROR_CALLBACK);
 	return new Memoized(callback, getMemoizationOptions(options));
 }
 const DEFAULT_CACHE_SIZE = 1024;
+const MEMOIZED_ERROR_CALLBACK = "Memoized requires a callback function";
+const MEMOIZED_ERROR_DESTROYED = "The Memoized instance has been destroyed";
 const SEPARATOR = "_";
 //#endregion
 export { memoize };

package/dist/function/once.d.mts

@@ -4,15 +4,17 @@ import { GenericAsyncCallback, GenericCallback, OnceAsyncCallback, OnceCallback
 /**
  * Create an asynchronous function that can only be called once, rejecting or resolving the same result on subsequent calls
  *
- * Available as `asyncOnce` and `once.async`
+ * _Available as `asyncOnce` and `once.async`_
+ *
  * @param callback Callback to use once
- * @returns Once callback
+ * @returns _Once_ callback
  */
 declare function asyncOnce<Callback extends GenericAsyncCallback>(callback: Callback): OnceAsyncCallback<Callback>;
 /**
  * Create a function that can only be called once, returning the same value on subsequent calls
+ *
  * @param callback Callback to use once
- * @returns Once callback
+ * @returns _Once_ callback
  */
 declare function once<Callback extends GenericCallback>(callback: Callback): OnceCallback<Callback>;
 declare namespace once {

package/dist/function/once.mjs

@@ -3,9 +3,10 @@ import { assert } from "./assert.mjs";
 /**
 * Create an asynchronous function that can only be called once, rejecting or resolving the same result on subsequent calls
 *
-* Available as `asyncOnce` and `once.async`
+* _Available as `asyncOnce` and `once.async`_
+*
 * @param callback Callback to use once
-* @returns Once callback
+* @returns _Once_ callback
 */
 function asyncOnce(callback) {
 	assert(() => typeof callback === "function", ONCE_MESSAGE_EXPECTATION);
@@ -66,8 +67,9 @@ function handleOnceResult(state, value, error) {
 }
 /**
 * Create a function that can only be called once, returning the same value on subsequent calls
+*
 * @param callback Callback to use once
-* @returns Once callback
+* @returns _Once_ callback
 */
 function once(callback) {
 	assert(() => typeof callback === "function", ONCE_MESSAGE_EXPECTATION);

package/dist/function/retry.d.mts

@@ -16,7 +16,8 @@ type RetryOptions = {
 /**
  * Retry a callback a specified number of times, with a delay between attempts
  *
- * Available as `asyncRetry` and `retry.async`
+ * _Available as `asyncRetry` and `retry.async`_
+ *
  * @param callback Callback to retry
  * @param options Retry options
  * @returns Callback result
@@ -25,7 +26,8 @@ declare function asyncRetry<Callback extends GenericAsyncCallback>(callback: Cal
 /**
  * Retry a callback a specified number of times, with a delay between attempts
  *
- * Available as `asyncRetry` and `retry.async`
+ * _Available as `asyncRetry` and `retry.async`_
+ *
  * @param callback Callback to retry
  * @param options Retry options
  * @returns Callback result
@@ -33,6 +35,7 @@ declare function asyncRetry<Callback extends GenericAsyncCallback>(callback: Cal
 declare function asyncRetry<Callback extends GenericCallback>(callback: Callback, options?: RetryOptions): Promise<ReturnType<Callback>>;
 /**
  * Retry a callback a specified number of times
+ *
  * @param callback Callback to retry
  * @param options Retry options
  * @returns Callback result

package/dist/function/retry.mjs

@@ -14,7 +14,8 @@ var RetryError = class extends Error {
 /**
 * Retry a callback a specified number of times, with a delay between attempts
 *
-* Available as `asyncRetry` and `retry.async`
+* _Available as `asyncRetry` and `retry.async`_
+*
 * @param callback Callback to retry
 * @param options Retry options
 * @returns Callback result
@@ -57,6 +58,7 @@ function getRetryOptions(input) {
 }
 /**
 * Retry a callback a specified number of times
+*
 * @param callback Callback to retry
 * @param options Retry options
 * @returns Callback result