@dereekb/util 13.3.1 → 13.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "13.3.1",
+  "version": "13.4.1",
   "exports": {
     "./test": {
       "module": "./test/index.esm.js",

package/src/lib/array/array.boolean.d.ts

@@ -16,24 +16,28 @@ export type BooleanStringKeyArray = BooleanKeyArray<BooleanStringKey>;
 export type BooleanKeyArray<T = string> = Maybe<T[]>;
 /**
  * Wraps a key reading function to ensure that empty string keys are not used in boolean key arrays.
+ *
  * @param readKey - The key reading function to wrap
  * @returns A wrapped key reading function that throws an error if an empty string is used as a key
  */
 export declare function readBooleanKeySafetyWrap<T>(readKey: ReadModelKeyFunction<T>): ReadModelKeyFunction<T>;
 /**
  * Checks if a boolean key array evaluates to false (empty or undefined).
+ *
  * @param value - The boolean key array to check
  * @returns True if the array is empty or undefined, false otherwise
  */
 export declare function isFalseBooleanKeyArray(value: BooleanKeyArray): boolean;
 /**
  * Checks if a boolean key array evaluates to true (has at least one value).
+ *
  * @param value - The boolean key array to check
  * @returns True if the array has at least one value, false otherwise
  */
 export declare function isTrueBooleanKeyArray(value: BooleanKeyArray): boolean;
 /**
  * Inserts a value into a boolean key array, removing any existing values with the same key.
+ *
  * @param array - The boolean key array to insert into
  * @param value - The value to insert
  * @param readKey - Function to extract the key from a value
@@ -42,6 +46,7 @@ export declare function isTrueBooleanKeyArray(value: BooleanKeyArray): boolean;
 export declare function insertIntoBooleanKeyArray<T>(array: BooleanKeyArray<T>, value: T, readKey: ReadModelKeyFunction<T>): BooleanKeyArray<T>;
 /**
  * Removes a value from a boolean key array based on its key.
+ *
  * @param array - The boolean key array to remove from
  * @param value - The value to remove
  * @param readKey - Function to extract the key from a value
@@ -50,6 +55,7 @@ export declare function insertIntoBooleanKeyArray<T>(array: BooleanKeyArray<T>,
 export declare function removeFromBooleanKeyArray<T>(array: BooleanKeyArray<T>, value: T, readKey: ReadModelKeyFunction<T>): BooleanKeyArray<T>;
 /**
  * Removes values from a boolean key array that match the specified key.
+ *
  * @param array - The boolean key array to remove from
  * @param key - The key to match for removal
  * @param readKey - Function to extract the key from a value
@@ -62,6 +68,7 @@ export declare function removeByKeyFromBooleanKeyArray<T>(array: BooleanKeyArray
 export type BooleanKeyArrayUtility<T> = ReturnType<typeof booleanKeyArrayUtility<T>>;
 /**
  * Creates a utility object with functions for working with boolean key arrays.
+ *
  * @param readKey - Function to extract the key from a value
  * @returns An object with utility functions for boolean key arrays
  */

package/src/lib/array/array.filter.d.ts

@@ -7,12 +7,12 @@ import { type AscendingSortCompareFunction } from '../sort';
  *
  * If order is irrelevant, use filterValuesByDistanceNoOrder() instead.
  *
- * @param input - The array of values to filter
- * @param minDistance - The minimum distance required between values
- * @param getValue - Function that extracts a numeric value from each item for distance comparison
+ * @param _input - The array of values to filter
+ * @param _minDistance - The minimum distance required between values
+ * @param _getValue - Function that extracts a numeric value from each item for distance comparison
  * @returns A filtered array with only values that are at least minDistance apart
  */
-export declare function filterValuesByDistance<T>(input: T[], minDistance: number, getValue: (value: T) => number | null): T[];
+export declare function filterValuesByDistance<T>(_input: T[], _minDistance: number, _getValue: (value: T) => number | null): T[];
 /**
  * Filters the input values by an arbitrary "distance"/difference from each other and returns the values sorted by their determined distance.
  *

package/src/lib/array/array.index.d.ts

@@ -15,7 +15,9 @@ export type IndexSetPairSet<T> = IndexSetPair<T>[];
  * Pairs an array item with its index position.
  */
 export interface IndexSetPair<T> extends IndexRef {
-    /** The item at the index, or undefined if no item exists at that position. */
+    /**
+     * The item at the index, or undefined if no item exists at that position.
+     */
     item: Maybe<T>;
 }
 /**

package/src/lib/array/array.indexed.d.ts

@@ -73,11 +73,17 @@ export declare function indexedValuesArrayAccessorFactory<T>(readIndexRange: Rea
  * Contains the match result for a ranged index lookup, including the matched value and its neighbors.
  */
 export interface RangedIndexValuesArrayAccessorInfo<T> {
-    /** The value from the range immediately before the matched or queried range. */
+    /**
+     * The value from the range immediately before the matched or queried range.
+     */
     readonly prev?: Maybe<T>;
-    /** The value whose range contains the queried index, or undefined if no range matched. */
+    /**
+     * The value whose range contains the queried index, or undefined if no range matched.
+     */
     readonly match?: Maybe<T>;
-    /** The value from the range immediately after the matched or queried range. */
+    /**
+     * The value from the range immediately after the matched or queried range.
+     */
     readonly next?: Maybe<T>;
 }
 /**

package/src/lib/array/array.limit.d.ts

@@ -18,6 +18,8 @@ export interface LimitArrayConfig {
  *
  * @param array - source array to limit
  * @param inputConfig - configuration controlling the limit count and direction
+ * @param inputConfig.limit - maximum number of items to include in the result
+ * @param inputConfig.limitFromEnd - when true, items are taken from the end of the array instead of the front
  * @returns a new array with at most the configured number of items, or the original array if no limit is specified
  */
 export declare function limitArray<T>(array: T[], { limit, limitFromEnd }: Partial<LimitArrayConfig>): T[];

package/src/lib/assertion/assert.d.ts

@@ -1,6 +1,7 @@
 /**
  * Interface for configuring a Description Assertion.
  * Provides options for customizing assertion messages.
+ *
  * @interface
  */
 export interface DescriptorAssertionOptions {
@@ -9,6 +10,7 @@ export interface DescriptorAssertionOptions {
 /**
  * DescriptorAssertionOptions extension that also maps one value to another.
  * Extends the base assertion options to include a mapping function.
+ *
  * @interface
  * @template T - The type of value being mapped
  */
@@ -16,6 +18,7 @@ export interface MapDescriptorAssertionOptions<T> extends DescriptorAssertionOpt
     /**
      * Maps the value after it has been validated.
      * This function is applied to transform the value after the assertion passes.
+     *
      * @param value - The value to transform after validation
      * @returns The transformed value
      */

package/src/lib/assertion/assert.error.d.ts

@@ -4,6 +4,7 @@ import { type DescriptorAssertionOptions } from './assert';
 /**
  * Interface representing an assertion issue that occurred.
  * Contains information about the object and property that failed the assertion.
+ *
  * @interface
  */
 export interface AssertionIssue {
@@ -35,11 +36,13 @@ export declare class AssertionError extends BaseError implements ReadableError {
     }, message: string);
     /**
      * Gets the target object that failed the assertion.
+     *
      * @returns The target object
      */
     get target(): object;
     /**
      * Gets the property key that failed the assertion.
+     *
      * @returns The property key as a string
      */
     get propertyKey(): string;
@@ -50,12 +53,14 @@ export declare class AssertionError extends BaseError implements ReadableError {
 export declare class AssertionIssueHandler {
     /**
      * Handles an assertion issue by throwing an appropriate exception.
+     *
      * @param error - The assertion issue to handle
      * @throws AssertionError
      */
     handle(error: AssertionIssue): void;
     /**
      * Builds an AssertionError from an AssertionIssue.
+     *
      * @param error - The assertion issue to build an exception from
      * @returns A new AssertionError instance
      */
@@ -63,6 +68,7 @@ export declare class AssertionIssueHandler {
     /**
      * Builds an error message string from an AssertionIssue.
      * Uses the custom message if provided, otherwise creates a default message.
+     *
      * @param error - The assertion issue to build a message for
      * @returns The error message string
      */

package/src/lib/boolean.d.ts

@@ -18,6 +18,9 @@ export type IsModified = boolean;
 export type TrueOrFalseString = 'true' | 'false';
 /**
  * If a non-null boolean value is provided, returns the opposite.
+ *
+ * @param x - the boolean value to invert, or a nullish value
+ * @returns the inverted boolean, or the original nullish value if input was null/undefined
  */
 export declare function invertMaybeBoolean(x: true): false;
 export declare function invertMaybeBoolean(x: false): true;

package/src/lib/date/expires.d.ts

@@ -84,7 +84,7 @@ export declare function expirationDetails<T extends Expires = Expires>(input: Ex
  * @param input - Input configuration used to calculate the expiration date
  * @returns The calculated expiration date, or null if no expiration is defined
  */
-export declare function calculateExpirationDate(input: ExpirationDetailsInput<any>): Maybe<Date>;
+export declare function calculateExpirationDate(input: ExpirationDetailsInput<Expires>): Maybe<Date>;
 /**
  * Returns true if the threshold has not passed since the next run time, compared to now.
  *
@@ -120,7 +120,7 @@ export declare function isThrottled(throttleTime: Maybe<Milliseconds>, lastRunAt
  * @param details - Collection of ExpirationDetails to check
  * @returns True if at least one item has not expired, false otherwise
  */
-export declare function checkAtleastOneNotExpired(details: ExpirationDetails<any>[]): boolean;
+export declare function checkAtleastOneNotExpired(details: ExpirationDetails<Expires>[]): boolean;
 /**
  * Returns true if any of the input ExpirationDetails have expired.
  * Useful for checking if any items in a collection need to be refreshed or removed.
@@ -131,4 +131,4 @@ export declare function checkAtleastOneNotExpired(details: ExpirationDetails<any
  * @param defaultIfEmpty - Default value to return if the list is empty (defaults to true)
  * @returns True if any item has expired, or the defaultIfEmpty value for an empty list
  */
-export declare function checkAnyHaveExpired(details: ExpirationDetails<any>[], defaultIfEmpty?: boolean): boolean;
+export declare function checkAnyHaveExpired(details: ExpirationDetails<Expires>[], defaultIfEmpty?: boolean): boolean;

package/src/lib/date/minute.d.ts

@@ -1,4 +1,17 @@
-import { type Milliseconds, type Seconds } from './date';
+import { type Milliseconds, type Minutes, type Seconds } from './date';
+/**
+ * Converts the input number of milliseconds to whole minutes by flooring the result.
+ *
+ * @param milliseconds - The number of milliseconds to convert.
+ * @returns The equivalent whole minutes, rounded down.
+ *
+ * @example
+ * ```ts
+ * millisecondsToMinutes(180000); // 3
+ * millisecondsToMinutes(90000);  // 1
+ * ```
+ */
+export declare function millisecondsToMinutes(milliseconds: Milliseconds): Minutes;
 /**
  * A pair of minutes and seconds.
  */
@@ -15,13 +28,6 @@ export interface MinutesAndSeconds {
  * @returns An object with the minute and second components
  */
 export declare function millisecondsToMinutesAndSeconds(milliseconds: Milliseconds): MinutesAndSeconds;
-/**
- * A pair of minutes and seconds.
- */
-export interface MinutesAndSeconds {
-    readonly minute: number;
-    readonly second: number;
-}
 /**
  * Converts the input number of seconds to the equivalent in minutes and seconds.
  *

package/src/lib/date/time.d.ts

@@ -118,5 +118,8 @@ export declare function makeTimer(duration: Milliseconds, startImmediately?: boo
 export declare function toggleTimerRunning(timer: Timer, toggleRun?: boolean): void;
 /**
  * Returns the approximate end date of the given timer. If a timer is already complete, it returns the time for now.
+ *
+ * @param timer - the timer whose end date to approximate
+ * @returns a Date representing the estimated end time, or null if no duration remains
  */
 export declare function approximateTimerEndDate(timer: Timer): Maybe<Date>;

package/src/lib/error/error.server.d.ts

@@ -25,6 +25,7 @@ export type ErrorMessageOrPartialServerError<T = ServerErrorResponseData> = stri
  * Normalizes a string or partial error into a Partial ServerError object.
  * If the input is a string, it becomes the message property.
  *
+ * @param message - a plain error message string that becomes the `message` property of the returned object
  * @param messageOrError - A string message or partial server error object
  * @returns A partial ServerError object
  */

package/src/lib/file/pdf.d.ts

@@ -12,4 +12,4 @@
  * @param buffer - Buffer-like object to check. Only requires the `lastIndexOf` method.
  * @returns true if both PDF markers are found in the expected positions.
  */
-export declare function bufferHasValidPdfMarkings(buffer: Pick<Buffer<ArrayBuffer>, 'lastIndexOf'>): boolean;
+export declare function bufferHasValidPdfMarkings(buffer: Pick<Buffer<ArrayBuffer>, 'lastIndexOf' | 'includes'>): boolean;

package/src/lib/getter/getter.cache.d.ts

@@ -35,7 +35,7 @@ export type CachedFactoryWithInput<T, A = unknown> = CachedGetter<T> & FactoryWi
  * The value is retrieved once on first call and cached permanently.
  * Use `reset()` to clear the cache and `init()` to reload.
  *
- * @param factory - The factory function to cache
+ * @param getter - the factory or getter function whose result will be cached
  * @returns A CachedFactoryWithInput that caches the first result
  */
 export declare function cachedGetter<T>(getter: Getter<T>): CachedFactoryWithInput<T>;

package/src/lib/grouping.d.ts

@@ -33,9 +33,13 @@ export interface PairsGroupingResult<T> {
  * Configuration for comparing two arrays to determine if their contents differ.
  */
 export interface ArrayContentsDifferentParams<T, K extends PrimativeKey = PrimativeKey> {
-    /** Extracts a unique key from each item for pairing items across arrays. */
+    /**
+     * Extracts a unique key from each item for pairing items across arrays.
+     */
     groupKeyFn: ReadKeyFunction<T, K>;
-    /** Compares two paired items for equality. */
+    /**
+     * Compares two paired items for equality.
+     */
     isEqual: EqualityComparatorFunction<T>;
 }
 /**
@@ -127,6 +131,9 @@ export declare function restoreOrderWithValues<T, K extends PrimativeKey = Prima
  * @param orderKeys - Keys defining the desired order.
  * @param values - Values to reorder.
  * @param params - Configuration including key reader, duplicate handling, and new-item behavior.
+ * @param params.readKey - function that extracts the grouping key from each value
+ * @param params.chooseRetainedValue - function that selects which value to keep when duplicates share the same key; defaults to keeping the first
+ * @param params.excludeNewItems - when true, values whose keys are not in `orderKeys` are omitted from the result; defaults to false
  * @returns The reordered values array.
  *
  * @example
@@ -145,6 +152,8 @@ export declare function restoreOrder<T, K extends PrimativeKey = PrimativeKey>(o
  * @param a - First array to compare.
  * @param b - Second array to compare.
  * @param params - Key extraction and equality functions.
+ * @param params.groupKeyFn - function that extracts a grouping key from each element for pairing
+ * @param params.isEqual - predicate that returns true when two paired elements are considered equal
  * @returns `true` if the array contents differ.
  */
 export declare function arrayContentsDiffer<T, K extends PrimativeKey = PrimativeKey>(a: T[] | undefined, b: T[] | undefined, { groupKeyFn, isEqual }: ArrayContentsDifferentParams<T, K>): boolean;

package/src/lib/map/map.key.d.ts

@@ -115,4 +115,4 @@ export declare function multiValueMapBuilder<T, K extends PrimativeKey = Primati
  * @param b - The second map
  * @returns true if the maps have the same keys, false otherwise
  */
-export declare function mapsHaveSameKeys<K>(a: Map<K, any>, b: Map<K, any>): boolean;
+export declare function mapsHaveSameKeys<K>(a: Map<K, unknown>, b: Map<K, unknown>): boolean;

package/src/lib/model/model.d.ts

@@ -68,15 +68,6 @@ export type MultiModelKeyMap<T> = Map<string, T>;
  * @returns The model's `id` value
  */
 export declare const readUniqueModelKey: (model: UniqueModel) => string | undefined;
-/**
- * Abstract base class for models identified by a unique {@link ModelKey}.
- *
- * Copies the `id` from the provided template during construction.
- */
-export declare abstract class AbstractUniqueModel {
-    id?: ModelKey;
-    constructor(template: Partial<AbstractUniqueModel>);
-}
 /**
  * Deduplicates an array of model keys using a Set.
  *
@@ -167,6 +158,9 @@ export declare function makeMultiModelKeyMap<T>(input: T[], read: ReadRelationKe
  *
  * @param input - A model object or a model key string
  * @param config - Handlers for model and key cases, plus whether input is required
+ * @param config.useModel - handler invoked when the input is a model object; if omitted, the model's key is passed to `useKey` instead
+ * @param config.useKey - handler invoked when the input is a model key string
+ * @param config.required - when true, throws an error if the input is nullish; defaults to false
  * @returns The result of the matched handler, or undefined if input is nullish and not required
  * @throws Error if `required` is true and input is nullish
  */
@@ -272,3 +266,14 @@ export type ModelTypeDataPairFactory<T, M extends ModelTypeString = ModelTypeStr
  * @returns Factory function that produces ModelTypeDataPair values
  */
 export declare function modelTypeDataPairFactory<T, M extends ModelTypeString = ModelTypeString>(typeReader: ReadModelTypeFunction<T, M>, defaultType?: string): ModelTypeDataPairFactory<T, M>;
+/**
+ * Abstract base class for models identified by a unique {@link ModelKey}.
+ *
+ * Copies the `id` from the provided template during construction.
+ *
+ * @deprecated Use {@link UniqueModel} instead.
+ */
+export declare abstract class AbstractUniqueModel {
+    id?: ModelKey;
+    constructor(template: Partial<UniqueModel>);
+}

package/src/lib/number/dollar.d.ts

@@ -7,6 +7,14 @@ export type WholeDollarAmount = number;
  * Dollar amount number.
  */
 export type DollarAmount = number;
+/**
+ * Dollars amount number per hour.
+ */
+export type DollarAmountPerHour = number;
+/**
+ * Dollars amount number per day.
+ */
+export type DollarAmountPerDay = number;
 export type CentsAmount = number;
 export interface DollarsPair {
     dollars: WholeDollarAmount;

package/src/lib/number/number.d.ts

@@ -103,6 +103,10 @@ export declare function isOddNumber(value: number): boolean;
 export declare function sumOfIntegersBetween(from: number, to: number): number;
 /**
  * A {@link SortCompareFunction} for numbers that sorts in ascending order.
+ *
+ * @param a - the first number to compare
+ * @param b - the second number to compare
+ * @returns a negative value if `a` is less than `b`, zero if equal, or a positive value if `a` is greater
  */
 export declare const sortCompareNumberFunction: SortCompareFunction<number>;
 /**

package/src/lib/object/index.d.ts

@@ -5,5 +5,6 @@ export * from './object.equal';
 export * from './object.key';
 export * from './object.map';
 export * from './object';
+export * from './object.flatten';
 export * from './object.filter.tuple';
 export * from './object.filter.pojo';

package/src/lib/object/object.equal.d.ts

@@ -29,7 +29,7 @@ export interface ObjectFieldEqualityCheckerConfig<T extends object> {
     /**
      * Fields to capture as part of the compressor.
      */
-    readonly fields: (ObjectFieldEqualityCheckerFieldConfig<T, any> | FieldOfType<T>)[];
+    readonly fields: (ObjectFieldEqualityCheckerFieldConfig<T, FieldOfType<T>> | FieldOfType<T>)[];
     /**
      * Default equality function to use when a field's equality function is not provided.
      */
@@ -77,7 +77,7 @@ export interface ObjectFieldEqualityCheckResults<T extends object> {
  * Function used to check if two objects are considered equal.
  */
 export type ObjectFieldEqualityChecker<T extends object> = ((a: Partial<T>, b: Partial<T>) => ObjectFieldEqualityCheckResults<T>) & {
-    readonly _fields: Map<keyof T, ObjectFieldEqualityCheckerFieldConfig<T, any>>;
+    readonly _fields: Map<keyof T, ObjectFieldEqualityCheckerFieldConfig<T, FieldOfType<T>>>;
 };
 /**
  * Creates an {@link ObjectFieldEqualityChecker} that compares two objects field-by-field using configured equality functions.

package/src/lib/object/object.filter.pojo.d.ts

@@ -78,6 +78,9 @@ export interface OverrideInObjectFunctionFactoryConfig<T extends object> {
  * By default, `undefined` values in sources are excluded from the template.
  *
  * @param config - Configuration controlling filtering, copying, and caching behavior.
+ * @param config.filter - filter applied to source object values when building the template; by default, `undefined` values are excluded
+ * @param config.copy - when true, the target object is shallow-copied before applying overrides instead of being mutated in place
+ * @param config.dynamic - when true, the template is recalculated on each call instead of being cached; useful when source objects may change over time
  * @returns A factory function that accepts source objects and returns an override function.
  *
  * @example
@@ -372,6 +375,8 @@ export type GeneralFilterFromPOJOFunction<X = object> = <T extends X>(input: T)
  * By default, removes `undefined` values (`KeyValueTypleValueFilter.UNDEFINED`) and does not copy (`copy: false`).
  *
  * @param config - Configuration for filtering and copying. Defaults to `{ copy: false, filter: { valueFilter: KeyValueTypleValueFilter.UNDEFINED } }`.
+ * @param config.copy - when true, returns a shallow copy with filtered keys removed instead of mutating the input; defaults to false
+ * @param config.filter - the filter criteria determining which key/value pairs to remove; defaults to removing `undefined` values
  * @returns A reusable filter function. The returned function also accepts a `copyOverride` argument to override the copy behavior per-call.
  *
  * @example
@@ -613,6 +618,8 @@ export type ForEachKeyValueOnPOJOConfig<T extends object, C = unknown, K extends
  * When no filter is provided, all key/value pairs are iterated.
  *
  * @param config - The filter and forEach callback configuration.
+ * @param config.forEach - callback invoked for each key/value pair that passes the filter
+ * @param config.filter - optional filter controlling which key/value pairs are iterated; when omitted, all pairs are visited
  * @returns A function that iterates matching key/value pairs on any input object.
  *
  * @example

package/src/lib/object/object.filter.tuple.d.ts

@@ -16,6 +16,8 @@ export interface ForEachKeyValue<T extends object = object, K extends keyof T =
  *
  * @param obj - Object to iterate
  * @param config - Configuration with a forEach callback and optional filter
+ * @param config.forEach - callback invoked for each key/value tuple that passes the filter
+ * @param config.filter - optional filter controlling which key/value tuples are iterated; when omitted, all tuples are visited
  *
  * @example
  * ```ts

package/src/lib/object/object.flatten.d.ts

@@ -0,0 +1,43 @@
+import { type Maybe } from '../value/maybe.type';
+/**
+ * Configuration for {@link flattenObject}.
+ */
+export interface FlattenObjectConfig {
+    /**
+     * Separator between key segments.
+     *
+     * @defaultValue '.'
+     */
+    readonly separator?: string;
+    /**
+     * Maximum nesting depth to flatten. A depth of 1 means only the first level of nested objects is flattened.
+     *
+     * @defaultValue Infinity (unlimited)
+     */
+    readonly maxDepth?: number;
+}
+/**
+ * Flattens a nested object into a single-level object with concatenated keys.
+ *
+ * Recursively traverses plain objects and joins nested keys with a separator (default `'.'`).
+ * Non-plain-object values (arrays, Dates, null, functions, etc.) are treated as leaf values and kept as-is.
+ * Empty nested objects are omitted from the result (they produce no keys).
+ * Circular references are detected and treated as leaf values to avoid infinite recursion.
+ *
+ * @example
+ * ```ts
+ * flattenObject({ a: 1, b: { c: 2, d: { e: 3 } } });
+ * // { a: 1, 'b.c': 2, 'b.d.e': 3 }
+ *
+ * flattenObject({ a: { b: 1 } }, { separator: '_' });
+ * // { a_b: 1 }
+ *
+ * flattenObject({ a: { b: { c: 1 } } }, { maxDepth: 1 });
+ * // { 'a.b': { c: 1 } }
+ * ```
+ *
+ * @param input - The object to flatten. If nullish, returns an empty object.
+ * @param config - Optional configuration for separator and max depth.
+ * @returns A new flat object with concatenated key paths.
+ */
+export declare function flattenObject(input: Maybe<Record<string, unknown>>, config?: FlattenObjectConfig): Record<string, unknown>;

package/src/lib/object/object.map.d.ts

@@ -60,7 +60,7 @@ export declare function mapObjectToTargetObject<M extends ObjectMap<I>, I = unkn
 /**
  * Maps each key of the input object to a new object using the pre-configured function.
  */
-export type MapObjectKeysFunction<M> = (object: M) => any;
+export type MapObjectKeysFunction<M> = (object: M) => unknown;
 /**
  * Map function that returns the new POJOKey using the input key/value pair.
  */

package/src/lib/path/path.d.ts

@@ -200,7 +200,9 @@ export declare function slashPathFolderFactory(config?: SlashPathFolderFactoryCo
  *
  * If the input is a file, the folder of the file is returned instead.
  *
- * @param input
+ * @param input - the string path to convert to a folder path
+ * @param config - optional configuration controlling path type inference and invalid-path handling
+ * @returns a valid slash path folder string with a trailing slash, or an empty string for relative root
  */
 export declare function slashPathFolder(input: string, config?: SlashPathFolderFactoryConfig): InferredSlashPathFolder;
 /**
@@ -547,7 +549,7 @@ export declare function slashPathPathMatcherConfig<N extends PrimativeValue = Pr
 /**
  * Creates a SlashPathPathMatcher.
  *
- * @param config The configuration for the matcher.
+ * @param input - the matcher configuration, which may be a target path string, an array of path parts, or a full config object
  * @returns The matcher.
  */
 export declare function slashPathPathMatcher<N extends PrimativeValue = PrimativeValue>(input: SlashPathPathMatcherConfigInput<N>): SlashPathPathMatcher<N>;

package/src/lib/promise/poll.d.ts

@@ -23,6 +23,9 @@ export interface PollConfig {
  * Polls at a regular interval until a condition is met or the maximum number of attempts is reached.
  *
  * @param config - Polling configuration including check function, wait interval, and max attempts.
+ * @param config.check - predicate function that returns true when the polling condition has been satisfied
+ * @param config.wait - milliseconds to wait between polling iterations; defaults to 250
+ * @param config.timesToGiveup - maximum number of polling iterations before giving up; defaults to `Number.MAX_SAFE_INTEGER`
  * @returns A Promise that resolves when the check condition returns `true` or the max attempts are exhausted.
  */
 export declare function poll({ check, wait, timesToGiveup }: PollConfig): Promise<void>;

package/src/lib/promise/promise.d.ts

@@ -44,22 +44,34 @@ export type PerformAsyncTaskFn<T, K = unknown> = (value: T, tryNumber?: number)
  * The result of executing a single async task via {@link performAsyncTask}.
  */
 export interface PerformAsyncTaskResult<O> {
-    /** The resulting value if the task succeeded, or undefined on failure. */
+    /**
+     * The resulting value if the task succeeded, or undefined on failure.
+     */
     readonly value: Maybe<O>;
-    /** Whether the task completed successfully. */
+    /**
+     * Whether the task completed successfully.
+     */
     readonly success: boolean;
 }
 /**
  * The aggregated result of executing multiple async tasks via {@link performAsyncTasks}.
  */
 export interface PerformAsyncTasksResult<I, O> {
-    /** Input values whose tasks succeeded. */
+    /**
+     * Input values whose tasks succeeded.
+     */
     readonly succeded: I[];
-    /** Input values whose tasks failed. */
+    /**
+     * Input values whose tasks failed.
+     */
     readonly failed: I[];
-    /** Tuples of [input, output] for each successful task. */
+    /**
+     * Tuples of [input, output] for each successful task.
+     */
     readonly results: [I, O][];
-    /** Tuples of [input, error] for each failed task. */
+    /**
+     * Tuples of [input, error] for each failed task.
+     */
     readonly errors: [I, unknown][];
 }
 /**
@@ -193,7 +205,7 @@ export type PerformTaskFactoryTasksInParallelFunction<I> = (taskInputFactory: Pe
  * with configurable concurrency limits and non-concurrent key constraints.
  *
  * @param config - Configuration for the task factory, parallelism, and concurrency behavior.
- * @returns A function that accepts a task input factory and returns a Promise resolving when all tasks complete.
+ * @returns a function that accepts a task input factory and returns a Promise that resolves when all tasks complete
  */
 export declare function performTasksFromFactoryInParallelFunction<I, K extends PrimativeKey = PerformTasksInParallelTaskUniqueKey>(config: PerformTasksFromFactoryInParallelFunctionConfig<I, K>): PerformTaskFactoryTasksInParallelFunction<I>;
 /**