@dereekb/util 13.11.14 → 13.11.15

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

@@ -30,8 +30,8 @@ export type TransformNumberFunctionConfigInput<S extends number = number> = Tran
  *
  * If a function is provided, wraps it as the `transform` field. Returns undefined for undefined input.
  *
- * @param config - A config object, a transform function, or undefined
- * @returns The normalized config, or undefined
+ * @param config - A config object, a transform function, or undefined.
+ * @returns The normalized config, or undefined.
  */
 export declare function transformNumberFunctionConfig<S extends number = number>(config?: TransformNumberFunctionConfigInput<S>): Maybe<TransformNumberFunctionConfig<S>>;
 /**
@@ -39,14 +39,15 @@ export declare function transformNumberFunctionConfig<S extends number = number>
  *
  * Chains the configured operations in order: custom transform, step rounding, precision cut, then bounds clamping.
  *
+ * @param config - Configuration with optional transform, roundToStep, precision, and bounds.
+ * @returns A single function that applies all configured transformations in sequence.
+ *
  * @dbxUtil
  * @dbxUtilCategory number
  * @dbxUtilKind factory
  * @dbxUtilTags number, transform, factory, round, precision, bounds, chain
  * @dbxUtilRelated transform-string-function, round-number-to-step-function
  *
- * @param config - Configuration with optional transform, roundToStep, precision, and bounds
- * @returns A single function that applies all configured transformations in sequence
  * @__NO_SIDE_EFFECTS__
  */
 export declare function transformNumberFunction<N extends number = number>(config: TransformNumberFunctionConfig<N>): TransformNumberFunction<N>;

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

@@ -5,9 +5,9 @@ import { type ArrayOrValue } from '../array';
  *
  * Convenience wrapper around {@link objectMergeMatrix} that flattens the result.
  *
- * @param a - First array (or single value) of partial objects
- * @param b - Second array (or single value) of partial objects
- * @returns Flat array of merged objects
+ * @param a - First array (or single value) of partial objects.
+ * @param b - Second array (or single value) of partial objects.
+ * @returns Flat array of merged objects.
  */
 export declare function objectFlatMergeMatrix<A extends object = object, B extends object = object>(a: ArrayOrValue<Partial<A>>, b: ArrayOrValue<Partial<B>>): (Partial<A> & Partial<B>)[];
 /**
@@ -16,8 +16,8 @@ export declare function objectFlatMergeMatrix<A extends object = object, B exten
  * Each element in the matrix is the spread merge of one item from a with one item from b.
  * If either input is null/undefined, returns the other as a single-row matrix.
  *
- * @param a - First array (or single value) of partial objects
- * @param b - Second array (or single value) of partial objects
- * @returns 2D array where result[i][j] is `{ ...a[i], ...b[j] }`
+ * @param a - First array (or single value) of partial objects.
+ * @param b - Second array (or single value) of partial objects.
+ * @returns Two-dimensional array where `result[i][j]` is `{ ...a[i], ...b[j] }`.
  */
 export declare function objectMergeMatrix<A extends object = object, B extends object = object>(a: ArrayOrValue<Partial<A>>, b: ArrayOrValue<Partial<B>>): (Partial<A> & Partial<B>)[][];

package/src/lib/object/object.array.delta.d.ts

@@ -45,14 +45,15 @@ export interface ObjectDeltaArrayCompressor<T extends object> {
  * The first object is stored fully. Subsequent objects store only fields that changed from the previous entry.
  * Null in a delta entry means the field was cleared. Undefined (missing key) means no change.
  *
+ * @param config - Configuration with the equality checker that defines which fields to track.
+ * @returns A compressor with `compress` and `expand` methods.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilKind factory
  * @dbxUtilTags object, delta, array, compress, expand, factory
  * @dbxUtilRelated equality-comparator-function, object-keys-equality-comparator-function
  *
- * @param config - Configuration with the equality checker that defines which fields to track
- * @returns A compressor with `compress` and `expand` methods
  * @__NO_SIDE_EFFECTS__
  */
 export declare function objectDeltaArrayCompressor<T extends object>(config: ObjectDeltaArrayCompressorConfig<T>): ObjectDeltaArrayCompressor<T>;

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

@@ -24,13 +24,13 @@ export type EmptyObject = Record<string, never>;
 /**
  * Checks whether the object has no own enumerable keys.
  *
+ * @param obj - Object to check.
+ * @returns `true` if the object has zero keys.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilTags object, empty, keys, check, type-guard
  * @dbxUtilRelated object-has-key, object-has-keys, has-value-or-not-empty-object
- *
- * @param obj - Object to check
- * @returns `true` if the object has zero keys
  */
 export declare function objectHasNoKeys(obj: object): obj is EmptyObject;
 /**
@@ -67,9 +67,9 @@ export declare function objectHasKeys<T, K extends keyof T>(obj: T, keys: K[], m
 /**
  * Creates a partial object with the same value assigned to each of the specified fields.
  *
- * @param value - The value to assign to each field
- * @param fields - Array of field names to set
- * @returns A partial object with the value set on each specified field
+ * @param value - The value to assign to each field.
+ * @param fields - Array of field names to set.
+ * @returns A partial object with the value set on each specified field.
  */
 export declare function applyToMultipleFields<T extends object, X = unknown>(value: X, fields: FieldOfType<T>[]): Partial<{
     [K in keyof T]: X;
@@ -77,12 +77,12 @@ export declare function applyToMultipleFields<T extends object, X = unknown>(val
 /**
  * Converts a Map to a plain object by iterating entries and assigning key-value pairs.
  *
+ * @param map - Map to convert.
+ * @returns A plain object with the same key-value pairs.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilTags object, map, convert, transform, dictionary
- *
- * @param map - Map to convert
- * @returns A plain object with the same key-value pairs
  */
 export declare function mapToObject<T, K extends PropertyKey>(map: Map<K, T>): {
     [key: PropertyKey]: T;
@@ -94,12 +94,12 @@ export type CopyObjectFunction<T> = (input: T) => T;
 /**
  * Creates a shallow copy of an object using the spread operator.
  *
+ * @param input - Object to copy.
+ * @returns A new object with the same properties.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilTags object, copy, clone, shallow, spread
  * @dbxUtilRelated copy-array
- *
- * @param input - Object to copy
- * @returns A new object with the same properties
  */
 export declare function copyObject<T extends object>(input: T): T;

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

@@ -3,12 +3,12 @@ import { type Maybe } from '../value/maybe.type';
  * Recursively checks whether an object is "empty" — meaning it is null/undefined, has no keys,
  * or all of its values are themselves empty (recursively for nested objects, or falsy for primitives).
  *
+ * @param obj - Object to check.
+ * @returns `true` if the object is considered empty.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilTags object, empty, recursive, deep, check, has-value
  * @dbxUtilRelated object-has-no-keys, has-value-or-not-empty-object
- *
- * @param obj - Object to check
- * @returns `true` if the object is considered empty
  */
 export declare function objectIsEmpty<T extends object>(obj: Maybe<T>): boolean;

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

@@ -6,14 +6,14 @@ import { type FilterFromPOJOFunction } from './object.filter.pojo';
  *
  * Recursively compares arrays, objects, Maps, Sets, primitives, and Dates.
  *
+ * @param a - First value to compare.
+ * @param b - Second value to compare.
+ * @returns `true` if the values are deeply equal.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilTags object, equal, equality, deep, compare, recursive, pojo
  * @dbxUtilRelated are-equal-pojo-values-using-pojo-filter, all-objects-are-equal
- *
- * @param a - First value to compare
- * @param b - Second value to compare
- * @returns `true` if the values are deeply equal
  */
 export declare function areEqualPOJOValues<F>(a: F, b: F): boolean;
 /**
@@ -21,10 +21,10 @@ export declare function areEqualPOJOValues<F>(a: F, b: F): boolean;
  *
  * Recursively compares arrays, objects, Maps, Sets, primitives, and Dates.
  *
- * @param a - First value to compare
- * @param b - Second value to compare
- * @param pojoFilter - Filter function applied to each value before comparison
- * @returns `true` if the filtered values are deeply equal
+ * @param a - First value to compare.
+ * @param b - Second value to compare.
+ * @param pojoFilter - Filter function applied to each value before comparison.
+ * @returns `true` if the filtered values are deeply equal.
  */
 export declare function areEqualPOJOValuesUsingPojoFilter<F>(a: F, b: F, pojoFilter: FilterFromPOJOFunction<F>): boolean;
 /**
@@ -89,14 +89,15 @@ export type ObjectFieldEqualityChecker<T extends object> = ((a: Partial<T>, b: P
  *
  * Fields can be specified as simple field names (using the default `===` comparator) or as config objects with custom comparators.
  *
+ * @param config - Configuration with the fields to compare and an optional default equality function.
+ * @returns Compares two objects and reports which fields are equal/unequal.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilKind factory
  * @dbxUtilTags object, equality, fields, comparator, factory
  * @dbxUtilRelated object-keys-equality-comparator-function, object-key-equality-comparator-function
  *
- * @param config - Configuration with the fields to compare and an optional default equality function
- * @returns A function that compares two objects and reports which fields are equal/unequal
  * @__NO_SIDE_EFFECTS__
  */
 export declare function objectFieldEqualityChecker<T extends object>(config: ObjectFieldEqualityCheckerConfig<T>): ObjectFieldEqualityChecker<T>;

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

@@ -14,7 +14,7 @@ export type StripObjectFunction<T extends object> = (input: Maybe<T>, copy?: May
  *
  * @param filter - Filter controlling which key/value pairs are removed from the input object.
  * @param copy - When true (default), the returned function shallow-copies the input before filtering instead of mutating it.
- * @returns A function that returns the stripped object, or `undefined` when filtering removed every key.
+ * @returns Returns the stripped object, or `undefined` when filtering removed every key.
  *
  * @dbxUtil
  * @dbxUtilCategory object
@@ -96,7 +96,7 @@ export interface OverrideInObjectFunctionFactoryConfig<T extends object> {
      * Accepts a {@link KeyValueTypleValueFilter} enum value or a {@link KeyValueTupleFilter} object.
      * When not provided, the default filter removes `undefined` values (i.e., `KeyValueTypleValueFilter.UNDEFINED`).
      */
-    filter?: FilterKeyValueTuplesInput<T>;
+    readonly filter?: FilterKeyValueTuplesInput<T>;
     /**
      * Whether or not to return a copy of the input value, rather than change it directly.
      * If true, a copy of the input object will be returned.
@@ -104,7 +104,7 @@ export interface OverrideInObjectFunctionFactoryConfig<T extends object> {
      *
      * False by default.
      */
-    copy?: boolean;
+    readonly copy?: boolean;
     /**
      * Whether or not the template being applied to objects should be recalculated each time.
      *
@@ -112,7 +112,7 @@ export interface OverrideInObjectFunctionFactoryConfig<T extends object> {
      *
      * False by default.
      */
-    dynamic?: boolean;
+    readonly dynamic?: boolean;
 }
 /**
  * Creates an {@link OverrideInObjectFunctionFactory} that merges source objects into a template,
@@ -125,11 +125,17 @@ 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
+ * @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.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, override, factory, merge, template, cached
+ * @dbxUtilRelated override-in-object, merge-objects-function, filter-from-pojo-function
+ *
  * @example
  * ```typescript
  * const factory = overrideInObjectFunctionFactory({ copy: true });
@@ -138,12 +144,6 @@ export interface OverrideInObjectFunctionFactoryConfig<T extends object> {
  * // result is { color: 'red', size: 10 } (a new copy)
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, override, factory, merge, template, cached
- * @dbxUtilRelated override-in-object, merge-objects-function, filter-from-pojo-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function overrideInObjectFunctionFactory<T extends object>({ filter, copy, dynamic }: OverrideInObjectFunctionFactoryConfig<T>): OverrideInObjectFunctionFactory<T>;
@@ -185,6 +185,12 @@ export type MergeObjectsFunction<T extends object> = (objects: Maybe<Partial<T>>
  * @param filter - Optional filter controlling which key/value pairs are included. Defaults to filtering out `undefined` values.
  * @returns A reusable merge function.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, merge, factory, filter
+ * @dbxUtilRelated merge-objects, override-in-object-function-factory
+ *
  * @example
  * ```typescript
  * const merge = mergeObjectsFunction();
@@ -195,12 +201,6 @@ export type MergeObjectsFunction<T extends object> = (objects: Maybe<Partial<T>>
  * const mergeNoNulls = mergeObjectsFunction(KeyValueTypleValueFilter.NULL);
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, merge, factory, filter
- * @dbxUtilRelated merge-objects, override-in-object-function-factory
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function mergeObjectsFunction<T extends object>(filter?: FilterKeyValueTuplesInput<T>): MergeObjectsFunction<T>;
@@ -335,6 +335,12 @@ export type GeneralFindPOJOKeysFunction = <T extends object>(obj: T) => (keyof T
  * @param filter - A {@link FilterKeyValueTuplesInput} controlling which values match. Required (no default).
  * @returns A reusable function that returns matching keys from any input object.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, keys, find, factory, filter
+ * @dbxUtilRelated find-pojo-keys, count-pojo-keys-function, for-each-key-value-on-pojo-function
+ *
  * @example
  * ```typescript
  * const findDefinedKeys = findPOJOKeysFunction(KeyValueTypleValueFilter.UNDEFINED);
@@ -342,12 +348,6 @@ export type GeneralFindPOJOKeysFunction = <T extends object>(obj: T) => (keyof T
  * // ['a', 'c']
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, keys, find, factory, filter
- * @dbxUtilRelated find-pojo-keys, count-pojo-keys-function, for-each-key-value-on-pojo-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function findPOJOKeysFunction<T extends object>(filter: FilterKeyValueTuplesInput<T>): FindPOJOKeysFunction<T>;
@@ -382,6 +382,12 @@ export type CountPOJOKeysFunction<T> = (obj: T) => number;
  * @param filter - A {@link FilterKeyValueTuplesInput} controlling which values are counted. Defaults to `KeyValueTypleValueFilter.UNDEFINED`.
  * @returns A reusable function that counts matching keys on any input object.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, keys, count, factory, filter
+ * @dbxUtilRelated count-pojo-keys, find-pojo-keys-function
+ *
  * @example
  * ```typescript
  * const countDefined = countPOJOKeysFunction();
@@ -389,12 +395,6 @@ export type CountPOJOKeysFunction<T> = (obj: T) => number;
  * // 2
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, keys, count, factory, filter
- * @dbxUtilRelated count-pojo-keys, find-pojo-keys-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function countPOJOKeysFunction<T extends object>(filter?: FilterKeyValueTuplesInput<T>): CountPOJOKeysFunction<T>;
@@ -454,10 +454,16 @@ 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
+ * @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.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, filter, factory, remove, copy
+ * @dbxUtilRelated filter-from-pojo, strip-object-function, assign-values-to-pojo-function
+ *
  * @example
  * ```typescript
  * // Default: removes undefined values, mutates in place
@@ -471,12 +477,6 @@ export type GeneralFilterFromPOJOFunction<X = object> = <T extends X>(input: T)
  * // result is { a: 1 }, original is unchanged
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, filter, factory, remove, copy
- * @dbxUtilRelated filter-from-pojo, strip-object-function, assign-values-to-pojo-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function filterFromPOJOFunction<T extends object>({ copy, filter: inputFilter }?: FilterFromPOJO<T>): FilterFromPOJOFunction<T>;
@@ -552,6 +552,12 @@ export type AssignValuesToPOJOFunctionInput<T extends object = object, K extends
  * @param input - Filter and copy configuration. Defaults to `KeyValueTypleValueFilter.UNDEFINED` (filter undefined, copy target).
  * @returns A reusable assign function with a `_returnCopyByDefault` property indicating the configured copy behavior.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, assign, factory, filter, copy
+ * @dbxUtilRelated assign-values-to-pojo, filter-from-pojo-function
+ *
  * @example
  * ```typescript
  * // Default: filters undefined, returns a copy
@@ -564,12 +570,6 @@ export type AssignValuesToPOJOFunctionInput<T extends object = object, K extends
  * const assignNoNulls = assignValuesToPOJOFunction({ valueFilter: KeyValueTypleValueFilter.NULL, copy: false });
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, assign, factory, filter, copy
- * @dbxUtilRelated assign-values-to-pojo, filter-from-pojo-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function assignValuesToPOJOFunction<T extends object, K extends keyof T = keyof T>(input?: AssignValuesToPOJOFunctionInput<T, K>): AssignValuesToPOJOFunction<T>;
@@ -607,6 +607,12 @@ export type ValuesFromPOJOFunction<O = unknown, I extends object = object> = (ob
  * @param filter - A {@link FilterKeyValueTuplesInput} controlling which values are included. Defaults to `KeyValueTypleValueFilter.UNDEFINED`.
  * @returns A reusable function that extracts matching values from any input object.
  *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, values, factory, filter, extract
+ * @dbxUtilRelated values-from-pojo, find-pojo-keys-function
+ *
  * @example
  * ```typescript
  * const getDefinedValues = valuesFromPOJOFunction();
@@ -618,12 +624,6 @@ export type ValuesFromPOJOFunction<O = unknown, I extends object = object> = (ob
  * // [1]
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, values, factory, filter, extract
- * @dbxUtilRelated values-from-pojo, find-pojo-keys-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function valuesFromPOJOFunction<O = unknown, I extends object = object>(filter?: FilterKeyValueTuplesInput<I>): ValuesFromPOJOFunction<O, I>;
@@ -635,7 +635,13 @@ export declare function valuesFromPOJOFunction<O = unknown, I extends object = o
  *
  * @param keysToFilter - The set of keys to include (or exclude when inverted).
  * @param invertFilter - When `true`, keys in `keysToFilter` are excluded instead of included. Defaults to `false`.
- * @returns A function that filters keys on any input POJO.
+ * @returns Filters keys on any input POJO.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, keys, filter, pick, omit, factory
+ * @dbxUtilRelated filter-tuples-on-pojo-function, filter-from-pojo-function
  *
  * @example
  * ```typescript
@@ -648,12 +654,6 @@ export declare function valuesFromPOJOFunction<O = unknown, I extends object = o
  * // { c: 3 }
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, keys, filter, pick, omit, factory
- * @dbxUtilRelated filter-tuples-on-pojo-function, filter-from-pojo-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function filterKeysOnPOJOFunction<T extends object>(keysToFilter: Iterable<string>, invertFilter?: boolean): FilterTuplesOnPOJOFunction<T>;
@@ -673,7 +673,13 @@ export type FilterTuplesOnPOJOFunction<T extends object> = T extends Record<stri
  * and returns a new object containing only the entries that pass.
  *
  * @param filterTupleOnObject - Predicate applied to each `[key, value]` entry.
- * @returns A function that filters entries on any input POJO.
+ * @returns Filters entries on any input POJO.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, tuples, filter, predicate, factory
+ * @dbxUtilRelated filter-keys-on-pojo-function, filter-from-pojo-function
  *
  * @example
  * ```typescript
@@ -682,12 +688,6 @@ export type FilterTuplesOnPOJOFunction<T extends object> = T extends Record<stri
  * // { a: 'hello', c: 'world' }
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, tuples, filter, predicate, factory
- * @dbxUtilRelated filter-keys-on-pojo-function, filter-from-pojo-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function filterTuplesOnPOJOFunction<T extends object>(filterTupleOnObject: FilterTuplesOnPOJOFilter<T>): FilterTuplesOnPOJOFunction<T>;
@@ -737,9 +737,15 @@ 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.
+ * @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 Iterates matching key/value pairs on any input object.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, pojo, for-each, iterate, factory, callback
+ * @dbxUtilRelated find-pojo-keys-function, count-pojo-keys-function, filter-key-value-tuples-function
  *
  * @example
  * ```typescript
@@ -751,12 +757,6 @@ export type ForEachKeyValueOnPOJOConfig<T extends object, C = unknown, K extends
  * // logs: 'a' 1, 'c' 'test'
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, pojo, for-each, iterate, factory, callback
- * @dbxUtilRelated find-pojo-keys-function, count-pojo-keys-function, filter-key-value-tuples-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function forEachKeyValueOnPOJOFunction<T extends object, C = unknown, K extends keyof T = keyof T>({ forEach, filter }: ForEachKeyValueOnPOJOConfig<T, C, K>): ForEachKeyValueOnPOJOFunction<T, C>;

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

@@ -14,10 +14,10 @@ export interface ForEachKeyValue<T extends object = object, K extends keyof T =
 /**
  * Iterates over filtered key/value tuples of an object and invokes a callback for each.
  *
- * @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
+ * @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
@@ -33,9 +33,9 @@ export declare function forEachKeyValue<T extends object = object, K extends key
 /**
  * Extracts key/value tuples from an object, optionally filtering them.
  *
- * @param obj - Object to extract tuples from
- * @param filter - Optional filter to apply to the tuples
- * @returns Array of matching key/value tuples
+ * @param obj - Object to extract tuples from.
+ * @param filter - Optional filter to apply to the tuples.
+ * @returns Array of matching key/value tuples.
  *
  * @example
  * ```ts
@@ -57,8 +57,14 @@ export type FilterKeyValueTuplesFunction<T extends object = object, K extends ke
  *
  * When no filter is provided, returns all key/value tuples.
  *
- * @param filter - Optional filter configuration
- * @returns A function that extracts filtered tuples from any input object
+ * @param filter - Optional filter configuration.
+ * @returns Extracts filtered tuples from any input object.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, tuples, filter, factory, key-value
+ * @dbxUtilRelated filter-key-value-tuple-function, for-each-key-value
  *
  * @example
  * ```ts
@@ -67,20 +73,14 @@ export type FilterKeyValueTuplesFunction<T extends object = object, K extends ke
  * // tuples: [['a', 1], ['c', 'hello']]
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, tuples, filter, factory, key-value
- * @dbxUtilRelated filter-key-value-tuple-function, for-each-key-value
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function filterKeyValueTuplesFunction<T extends object = object, K extends keyof T = keyof T>(filter?: FilterKeyValueTuplesInput<T, K>): FilterKeyValueTuplesFunction<T, K>;
 /**
  * Returns all key/value pairs from the object as tuples using `Object.entries`.
  *
- * @param obj - Object to extract tuples from
- * @returns Array of `[key, value]` tuples
+ * @param obj - Object to extract tuples from.
+ * @returns Array of `[key, value]` tuples.
  *
  * @example
  * ```ts
@@ -153,8 +153,8 @@ export interface KeyValueTupleFilter<T extends object = object, K extends keyof
  *
  * If the input is already an object, returns it as-is. If it's an enum value, wraps it in a filter object.
  *
- * @param input - Enum value or filter object
- * @returns Normalized filter object
+ * @param input - Enum value or filter object.
+ * @returns Normalized filter object.
  */
 export declare function filterKeyValueTuplesInputToFilter<T extends object = object, K extends keyof T = keyof T>(input: FilterKeyValueTuplesInput<T, K>): KeyValueTupleFilter<T, K>;
 /**
@@ -168,7 +168,13 @@ export type FilterKeyValueTupleFunction<T extends object = object, K extends key
  * (undefined, null, falsy, empty), key filtering, and inversion.
  *
  * @param inputFilter - Filter configuration (enum value or full config object)
- * @returns A predicate function that tests individual key/value tuples
+ * @returns A predicate function that tests individual key/value tuples.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory object
+ * @dbxUtilKind factory
+ * @dbxUtilTags object, tuple, filter, predicate, factory, key-value
+ * @dbxUtilRelated filter-key-value-tuples-function
  *
  * @example
  * ```ts
@@ -177,12 +183,6 @@ export type FilterKeyValueTupleFunction<T extends object = object, K extends key
  * isNotNull(['b', null], 0); // false
  * ```
  *
- * @dbxUtil
- * @dbxUtilCategory object
- * @dbxUtilKind factory
- * @dbxUtilTags object, tuple, filter, predicate, factory, key-value
- * @dbxUtilRelated filter-key-value-tuples-function
- *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function filterKeyValueTupleFunction<T extends object = object, K extends keyof T = keyof T>(inputFilter: FilterKeyValueTuplesInput<T, K>): FilterKeyValueTupleFunction<T, K>;

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

@@ -24,6 +24,10 @@ export interface FlattenObjectConfig {
  * 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.
  *
+ * @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.
+ *
  * @dbxUtil
  * @dbxUtilCategory object
  * @dbxUtilTags object, flatten, flat, nested, dot-notation, deep, traverse
@@ -39,9 +43,5 @@ export interface FlattenObjectConfig {
  * 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>;