@ls-stack/utils 3.40.0 → 3.42.0

package/dist/filterObjectOrArrayKeys.d.ts

@@ -2,22 +2,27 @@
  * Filters the keys of an object based on the provided patterns.
  *
  * Filtering patterns in `rejectKeys` and `filterKeys`:
+ *
  * - `'prop'` - Only root-level properties named 'prop'
  * - `'**prop'` - Any property named exactly 'prop' at any level (root or nested)
- * - `'*.prop'` - Any nested property named 'prop' at second level (excludes root-level matches)
+ * - `'*.prop'` - Any nested property named 'prop' at second level (excludes
+ *   root-level matches)
  * - `'test.*.prop'` - Any property named 'prop' at second level of 'test'
  * - `'test.*.test.**prop'` - Any property named 'prop' inside of 'test.*.test'
  * - `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
- * - `'prop.**nested'` - All nested properties inside root `prop` with name `nested`
+ * - `'prop.**nested'` - All nested properties inside root `prop` with name
+ *   `nested`
  * - `'prop[0]'` - The first item of the `prop` array
  * - `'prop[*]'` - All items of the `prop` array
  * - `'prop[0].nested'` - `nested` prop of the first item of the `prop` array
  * - `'prop[*].nested'` - `nested` prop of all items of the `prop` array
  * - `'prop[*]**nested'` - all `nested` props of all items of the `prop` array
  * - `'prop[0-2]'` - The first three items of the `prop` array
- * - `'prop[4-*]'` - All items of the `prop` array from the fourth index to the end
+ * - `'prop[4-*]'` - All items of the `prop` array from the fourth index to the
+ *   end
  * - `'prop[0-2].nested.**prop'` - Combining multiple nested patterns is supported
  * - Root array:
+ *
  *   - `'[0]'` - The first item of the root array
  *   - `'[*]'` - All items of the array
  *   - `'[0].nested'` - `nested` prop of the first item of the array
@@ -26,30 +31,50 @@
  *   - `'[0-2]'` - The first three items of the array
  *   - `'[4-*]'` - All items of the array from the fourth index to the end
  * - Pattern expansion with parentheses:
- *   - `'prop.test.(prop1|prop2|prop3)'` - Expands to `prop.test.prop1`, `prop.test.prop2`, and `prop.test.prop3`
- *   - `'components[*].(table_id|columns|filters[*].value)'` - Expands to `components[*].table_id`, `components[*].columns`, and `components[*].filters[*].value`
+ *
+ *   - `'prop.test.(prop1|prop2|prop3)'` - Expands to `prop.test.prop1`,
+ *       `prop.test.prop2`, and `prop.test.prop3`
+ *   - `'components[*].(table_id|columns|filters[*].value)'` - Expands to
+ *       `components[*].table_id`, `components[*].columns`, and
+ *       `components[*].filters[*].value`
  *   - `'(users|admins)[*].name'` - Expands to `users[*].name` and `admins[*].name`
  * - Array filtering by value:
- *   - `'users[%name="John"]'` - Filters the `users` with the `name` property equal to `John`
- *   - `'users[%name="John" | "Jane"]'` - Value-level OR using `|` for multiple values of same property
- *   - `'users[%name="Alice" || %age=35]'` - Property-level OR using `||` for different properties
- *   - `'users[%age=30 && %role="admin"]'` - Property-level AND using `&&` for different properties
- *   - Note: Mixing `&&` and `||` in the same filter is not supported - use separate filter patterns instead
+ *
+ *   - `'users[%name="John"]'` - Filters the `users` with the `name` property equal
+ *       to `John`
+ *   - `'users[%name="John" | "Jane"]'` - Value-level OR using `|` for multiple
+ *       values of same property
+ *   - `'users[%name="Alice" || %age=35]'` - Property-level OR using `||` for
+ *       different properties
+ *   - `'users[%age=30 && %role="admin"]'` - Property-level AND using `&&` for
+ *       different properties
+ *   - Note: Mixing `&&` and `||` in the same filter is not supported - use separate
+ *       filter patterns instead
  *   - `'users[%config.name="John" | "Jane"]'` - Dot notation is supported
- *   - `'users[%name*="oh"]'` - Contains operator (*=) - filters users where name contains "oh"
- *   - `'users[%name^="Jo"]'` - Starts with operator (^=) - filters users where name starts with "Jo"
- *   - `'users[%name$="hn"]'` - Ends with operator ($=) - filters users where name ends with "hn"
- *   - `'users[%name!="John"]'` - Not equal operator (!=) - filters users where name is not "John"
- *   - `'users[%name!*="admin"]'` - Not contains operator (!*=) - filters users where name doesn't contain "admin"
- *   - `'users[i%name="john"]'` - Case-insensitive matching (i% prefix) - matches "John", "JOHN", "john", etc.
+ *   - `'users[%name*="oh"]'` - Contains operator (*=) - filters users where name
+ *       contains "oh"
+ *   - `'users[%name^="Jo"]'` - Starts with operator (^=) - filters users where name
+ *       starts with "Jo"
+ *   - `'users[%name$="hn"]'` - Ends with operator ($=) - filters users where name
+ *       ends with "hn"
+ *   - `'users[%name!="John"]'` - Not equal operator (!=) - filters users where name
+ *       is not "John"
+ *   - `'users[%name!*="admin"]'` - Not contains operator (!*=) - filters users
+ *       where name doesn't contain "admin"
+ *   - `'users[i%name="john"]'` - Case-insensitive matching (i% prefix) - matches
+ *       "John", "JOHN", "john", etc.
  *
  * @param objOrArray - The object or array to filter.
  * @param options - The options for the filter.
  * @param options.filterKeys - The keys to filter.
  * @param options.rejectKeys - The keys to reject.
- * @param options.rejectEmptyObjectsInArray - Whether to reject empty objects in arrays (default: true).
- * @param options.sortKeys - Sort all keys by a specific order (optional, preserves original order when not specified).
- * @param options.sortPatterns - Sort specific keys by pattern. Use to control the order of specific properties. The same patterns as `filterKeys` are supported.
+ * @param options.rejectEmptyObjectsInArray - Whether to reject empty objects in
+ *   arrays (default: true).
+ * @param options.sortKeys - Sort all keys by a specific order (optional,
+ *   preserves original order when not specified).
+ * @param options.sortPatterns - Sort specific keys by pattern. Use to control
+ *   the order of specific properties. The same patterns as `filterKeys` are
+ *   supported.
  * @returns The filtered object or array.
  */
 declare function filterObjectOrArrayKeys(objOrArray: Record<string, any> | Record<string, any>[], { filterKeys, rejectKeys, rejectEmptyObjectsInArray, sortKeys, sortPatterns, }: {

package/dist/getAutoIncrementId.d.cts

@@ -1,40 +1,42 @@
 /**
- * Returns a unique auto-incrementing number each time it's called.
- * This is useful for generating simple unique identifiers within a single session/process.
+ * Returns a unique auto-incrementing number each time it's called. This is
+ * useful for generating simple unique identifiers within a single
+ * session/process.
  *
  * **Note:** This is not suitable for distributed systems or persistent storage.
- * For cryptographically secure or collision-resistant IDs, use `nanoid()` instead.
- *
- * @returns A unique incrementing number starting from 1
+ * For cryptographically secure or collision-resistant IDs, use `nanoid()`
+ * instead.
  *
  * @example
- * ```ts
- * const id1 = getAutoIncrementId(); // 1
- * const id2 = getAutoIncrementId(); // 2
- * const id3 = getAutoIncrementId(); // 3
- * ```
+ *   ```ts
+ *   const id1 = getAutoIncrementId(); // 1
+ *   const id2 = getAutoIncrementId(); // 2
+ *   const id3 = getAutoIncrementId(); // 3
+ *   ```;
+ *
+ * @returns A unique incrementing number starting from 1
  */
 declare function getAutoIncrementId(): number;
 /**
  * Creates a local auto-increment ID generator with optional prefix and suffix.
- * Each generator maintains its own independent counter starting from 1.
- * This is useful when you need multiple independent ID sequences or formatted IDs.
+ * Each generator maintains its own independent counter starting from 1. This is
+ * useful when you need multiple independent ID sequences or formatted IDs.
+ *
+ * @example
+ *   ```ts
+ *   const userIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'user-' });
+ *   const postIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'post-', suffix: '-draft' });
+ *
+ *   console.log(userIdGen()); // "user-1"
+ *   console.log(userIdGen()); // "user-2"
+ *   console.log(postIdGen()); // "post-1-draft"
+ *   console.log(postIdGen()); // "post-2-draft"
+ *   ```;
  *
  * @param options - Configuration object
  * @param options.prefix - Optional prefix to prepend to each generated ID
  * @param options.suffix - Optional suffix to append to each generated ID
  * @returns A function that generates formatted auto-increment IDs
- *
- * @example
- * ```ts
- * const userIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'user-' });
- * const postIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'post-', suffix: '-draft' });
- *
- * console.log(userIdGen()); // "user-1"
- * console.log(userIdGen()); // "user-2"
- * console.log(postIdGen()); // "post-1-draft"
- * console.log(postIdGen()); // "post-2-draft"
- * ```
  */
 declare function getLocalAutoIncrementIdGenerator({ prefix, suffix, }: {
     prefix?: string;

package/dist/getAutoIncrementId.d.ts

@@ -1,40 +1,42 @@
 /**
- * Returns a unique auto-incrementing number each time it's called.
- * This is useful for generating simple unique identifiers within a single session/process.
+ * Returns a unique auto-incrementing number each time it's called. This is
+ * useful for generating simple unique identifiers within a single
+ * session/process.
  *
  * **Note:** This is not suitable for distributed systems or persistent storage.
- * For cryptographically secure or collision-resistant IDs, use `nanoid()` instead.
- *
- * @returns A unique incrementing number starting from 1
+ * For cryptographically secure or collision-resistant IDs, use `nanoid()`
+ * instead.
  *
  * @example
- * ```ts
- * const id1 = getAutoIncrementId(); // 1
- * const id2 = getAutoIncrementId(); // 2
- * const id3 = getAutoIncrementId(); // 3
- * ```
+ *   ```ts
+ *   const id1 = getAutoIncrementId(); // 1
+ *   const id2 = getAutoIncrementId(); // 2
+ *   const id3 = getAutoIncrementId(); // 3
+ *   ```;
+ *
+ * @returns A unique incrementing number starting from 1
  */
 declare function getAutoIncrementId(): number;
 /**
  * Creates a local auto-increment ID generator with optional prefix and suffix.
- * Each generator maintains its own independent counter starting from 1.
- * This is useful when you need multiple independent ID sequences or formatted IDs.
+ * Each generator maintains its own independent counter starting from 1. This is
+ * useful when you need multiple independent ID sequences or formatted IDs.
+ *
+ * @example
+ *   ```ts
+ *   const userIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'user-' });
+ *   const postIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'post-', suffix: '-draft' });
+ *
+ *   console.log(userIdGen()); // "user-1"
+ *   console.log(userIdGen()); // "user-2"
+ *   console.log(postIdGen()); // "post-1-draft"
+ *   console.log(postIdGen()); // "post-2-draft"
+ *   ```;
  *
  * @param options - Configuration object
  * @param options.prefix - Optional prefix to prepend to each generated ID
  * @param options.suffix - Optional suffix to append to each generated ID
  * @returns A function that generates formatted auto-increment IDs
- *
- * @example
- * ```ts
- * const userIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'user-' });
- * const postIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'post-', suffix: '-draft' });
- *
- * console.log(userIdGen()); // "user-1"
- * console.log(userIdGen()); // "user-2"
- * console.log(postIdGen()); // "post-1-draft"
- * console.log(postIdGen()); // "post-2-draft"
- * ```
  */
 declare function getLocalAutoIncrementIdGenerator({ prefix, suffix, }: {
     prefix?: string;

package/dist/getCompositeKey.d.cts

@@ -2,7 +2,8 @@
  * Returns a stable key for the input value.
  *
  * @param input - The value to get a stable key for.
- * @param maxSortingDepth - The maximum depth to sort the input value. Default is 3.
+ * @param maxSortingDepth - The maximum depth to sort the input value. Default
+ *   is 3.
  * @returns A stable key for the input value.
  */
 declare function getCompositeKey(input: unknown, maxSortingDepth?: number): string;

package/dist/getCompositeKey.d.ts

@@ -2,7 +2,8 @@
  * Returns a stable key for the input value.
  *
  * @param input - The value to get a stable key for.
- * @param maxSortingDepth - The maximum depth to sort the input value. Default is 3.
+ * @param maxSortingDepth - The maximum depth to sort the input value. Default
+ *   is 3.
  * @returns A stable key for the input value.
  */
 declare function getCompositeKey(input: unknown, maxSortingDepth?: number): string;

package/dist/getValueStableKey.d.cts

@@ -3,11 +3,12 @@ import { getCompositeKey } from './getCompositeKey.cjs';
 /**
  * Returns a stable key for the input value.
  *
+ * @deprecated Use `getCompositeKey` from `@ls-stack/utils/getCompositeKey`
+ *   instead.
  * @param input - The value to get a stable key for.
- * @param maxSortingDepth - The maximum depth to sort the input value. Default is 3.
+ * @param maxSortingDepth - The maximum depth to sort the input value. Default
+ *   is 3.
  * @returns A stable key for the input value.
- *
- * @deprecated Use `getCompositeKey` from `@ls-stack/utils/getCompositeKey` instead.
  */
 declare const getValueStableKey: typeof getCompositeKey;
 

package/dist/getValueStableKey.d.ts

@@ -3,11 +3,12 @@ import { getCompositeKey } from './getCompositeKey.js';
 /**
  * Returns a stable key for the input value.
  *
+ * @deprecated Use `getCompositeKey` from `@ls-stack/utils/getCompositeKey`
+ *   instead.
  * @param input - The value to get a stable key for.
- * @param maxSortingDepth - The maximum depth to sort the input value. Default is 3.
+ * @param maxSortingDepth - The maximum depth to sort the input value. Default
+ *   is 3.
  * @returns A stable key for the input value.
- *
- * @deprecated Use `getCompositeKey` from `@ls-stack/utils/getCompositeKey` instead.
  */
 declare const getValueStableKey: typeof getCompositeKey;
 

package/dist/mutationUtils.d.cts

@@ -1,6 +1,6 @@
 /**
- * Updates an object with a new set of values. undefined values are ignored in the updates object
- * and deep equal values are not updated.
+ * Updates an object with a new set of values. undefined values are ignored in
+ * the updates object and deep equal values are not updated.
  *
  * @param object - The object to update.
  * @param updates - The new values to update the object with.

package/dist/mutationUtils.d.ts

@@ -1,6 +1,6 @@
 /**
- * Updates an object with a new set of values. undefined values are ignored in the updates object
- * and deep equal values are not updated.
+ * Updates an object with a new set of values. undefined values are ignored in
+ * the updates object and deep equal values are not updated.
  *
  * @param object - The object to update.
  * @param updates - The new values to update the object with.

package/dist/objUtils.cjs

@@ -20,15 +20,50 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/objUtils.ts
 var objUtils_exports = {};
 __export(objUtils_exports, {
+  filterObjectKeys: () => filterObjectKeys,
   looseGetObjectProperty: () => looseGetObjectProperty,
   mapArrayToObject: () => mapArrayToObject,
   mapObjectToObject: () => mapObjectToObject,
   objectTypedEntries: () => objectTypedEntries,
   omit: () => omit,
   pick: () => pick,
-  rejectObjUndefinedValues: () => rejectObjUndefinedValues
+  rejectObjUndefinedValues: () => rejectObjUndefinedValues,
+  sortObjectKeys: () => sortObjectKeys
 });
 module.exports = __toCommonJS(objUtils_exports);
+
+// src/arrayUtils.ts
+function sortBy(arr, sortByValue, props = "asc") {
+  const order = Array.isArray(props) || typeof props === "string" ? props : props.order ?? "asc";
+  return [...arr].sort((a, b) => {
+    const _aPriority = sortByValue(a);
+    const _bPriority = sortByValue(b);
+    const aPriority = Array.isArray(_aPriority) ? _aPriority : [_aPriority];
+    const bPriority = Array.isArray(_bPriority) ? _bPriority : [_bPriority];
+    for (let i = 0; i < aPriority.length; i++) {
+      const levelOrder = typeof order === "string" ? order : order[i] ?? "asc";
+      const aP = aPriority[i] ?? 0;
+      const bP = bPriority[i] ?? 0;
+      if (aP === bP) {
+        continue;
+      }
+      if (bP === Infinity || aP === -Infinity || aP < bP) {
+        return levelOrder === "asc" ? -1 : 1;
+      }
+      if (aP === Infinity || bP === -Infinity || aP > bP) {
+        return levelOrder === "asc" ? 1 : -1;
+      }
+    }
+    return 0;
+  });
+}
+
+// src/typingFnUtils.ts
+function typedObjectEntries(obj) {
+  return Object.entries(obj);
+}
+
+// src/objUtils.ts
 function objectTypedEntries(obj) {
   return Object.entries(obj);
 }
@@ -68,13 +103,27 @@ function rejectObjUndefinedValues(obj) {
   }
   return result;
 }
+function filterObjectKeys(obj, predicate) {
+  return Object.fromEntries(
+    Object.entries(obj).filter(
+      ([key, value]) => predicate(key, value)
+    )
+  );
+}
+function sortObjectKeys(obj, sortByFn, options) {
+  return Object.fromEntries(
+    sortBy(typedObjectEntries(obj), sortByFn, options)
+  );
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  filterObjectKeys,
   looseGetObjectProperty,
   mapArrayToObject,
   mapObjectToObject,
   objectTypedEntries,
   omit,
   pick,
-  rejectObjUndefinedValues
+  rejectObjUndefinedValues,
+  sortObjectKeys
 });

package/dist/objUtils.d.cts

@@ -1,6 +1,9 @@
+import { SortByValueFn, SortByProps } from './arrayUtils.cjs';
+import { MakeUndefinedKeysOptional } from './typeUtils.cjs';
+
 /**
+ * @deprecated Use typedObjectEntries from @ls-stack/utils/typingFnUtils instead
  * @param obj
- * @deprecated use typedObjectEntries from @ls-stack/utils/typingFnUtils instead
  */
 declare function objectTypedEntries<T extends Record<string, unknown>>(obj: T): [Extract<keyof T, string>, T[keyof T]][];
 declare function pick<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
@@ -8,6 +11,8 @@ declare function mapArrayToObject<T, K extends string, O>(array: T[], mapper: (i
 declare function mapObjectToObject<I extends Record<string | number | symbol, unknown>, K extends string | number | symbol, O>(obj: I, mapper: (key: keyof I, value: I[keyof I]) => [K, O]): Record<K, O>;
 declare function omit<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
 declare function looseGetObjectProperty<T extends Record<string, unknown>>(obj: T, key: string): T[keyof T] | undefined;
-declare function rejectObjUndefinedValues<T extends Record<string, unknown>>(obj: T): T;
+declare function rejectObjUndefinedValues<T extends Record<string, unknown>>(obj: T): MakeUndefinedKeysOptional<T>;
+declare function filterObjectKeys<T extends Record<string, unknown>>(obj: T, predicate: (key: keyof T, value: T[keyof T]) => boolean): Partial<T>;
+declare function sortObjectKeys<T extends Record<string, unknown>>(obj: T, sortByFn: SortByValueFn<[key: keyof T, value: T[keyof T]]>, options?: SortByProps): T;
 
-export { looseGetObjectProperty, mapArrayToObject, mapObjectToObject, objectTypedEntries, omit, pick, rejectObjUndefinedValues };
+export { filterObjectKeys, looseGetObjectProperty, mapArrayToObject, mapObjectToObject, objectTypedEntries, omit, pick, rejectObjUndefinedValues, sortObjectKeys };

package/dist/objUtils.d.ts

@@ -1,6 +1,9 @@
+import { SortByValueFn, SortByProps } from './arrayUtils.js';
+import { MakeUndefinedKeysOptional } from './typeUtils.js';
+
 /**
+ * @deprecated Use typedObjectEntries from @ls-stack/utils/typingFnUtils instead
  * @param obj
- * @deprecated use typedObjectEntries from @ls-stack/utils/typingFnUtils instead
  */
 declare function objectTypedEntries<T extends Record<string, unknown>>(obj: T): [Extract<keyof T, string>, T[keyof T]][];
 declare function pick<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
@@ -8,6 +11,8 @@ declare function mapArrayToObject<T, K extends string, O>(array: T[], mapper: (i
 declare function mapObjectToObject<I extends Record<string | number | symbol, unknown>, K extends string | number | symbol, O>(obj: I, mapper: (key: keyof I, value: I[keyof I]) => [K, O]): Record<K, O>;
 declare function omit<T extends Record<string, unknown>, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
 declare function looseGetObjectProperty<T extends Record<string, unknown>>(obj: T, key: string): T[keyof T] | undefined;
-declare function rejectObjUndefinedValues<T extends Record<string, unknown>>(obj: T): T;
+declare function rejectObjUndefinedValues<T extends Record<string, unknown>>(obj: T): MakeUndefinedKeysOptional<T>;
+declare function filterObjectKeys<T extends Record<string, unknown>>(obj: T, predicate: (key: keyof T, value: T[keyof T]) => boolean): Partial<T>;
+declare function sortObjectKeys<T extends Record<string, unknown>>(obj: T, sortByFn: SortByValueFn<[key: keyof T, value: T[keyof T]]>, options?: SortByProps): T;
 
-export { looseGetObjectProperty, mapArrayToObject, mapObjectToObject, objectTypedEntries, omit, pick, rejectObjUndefinedValues };
+export { filterObjectKeys, looseGetObjectProperty, mapArrayToObject, mapObjectToObject, objectTypedEntries, omit, pick, rejectObjUndefinedValues, sortObjectKeys };

package/dist/objUtils.js

@@ -1,18 +1,26 @@
 import {
+  filterObjectKeys,
   looseGetObjectProperty,
   mapArrayToObject,
   mapObjectToObject,
   objectTypedEntries,
   omit,
   pick,
-  rejectObjUndefinedValues
-} from "./chunk-GHAQOUA6.js";
+  rejectObjUndefinedValues,
+  sortObjectKeys
+} from "./chunk-Y45CE75W.js";
+import "./chunk-GMJTLFM6.js";
+import "./chunk-27AL66CH.js";
+import "./chunk-C2SVCIWE.js";
+import "./chunk-JF2MDHOJ.js";
 export {
+  filterObjectKeys,
   looseGetObjectProperty,
   mapArrayToObject,
   mapObjectToObject,
   objectTypedEntries,
   omit,
   pick,
-  rejectObjUndefinedValues
+  rejectObjUndefinedValues,
+  sortObjectKeys
 };

package/dist/parallelAsyncCalls.cjs

@@ -56,7 +56,8 @@ var ParallelAsyncResultCalls = class {
     return this;
   }
   /**
-   * adds calls return tuples with inferred results
+   * Adds calls return tuples with inferred results
+   *
    * @param calls
    */
   addTuple(...calls) {

package/dist/parallelAsyncCalls.d.cts

@@ -38,7 +38,8 @@ declare class ParallelAsyncResultCalls<M extends ValidMetadata | undefined = und
         fn: () => Promise<Result<R>>;
     }): this;
     /**
-     * adds calls return tuples with inferred results
+     * Adds calls return tuples with inferred results
+     *
      * @param calls
      */
     addTuple<T extends (M extends undefined ? () => Promise<Result<R>> : {
@@ -69,12 +70,12 @@ declare class ParallelAsyncResultCalls<M extends ValidMetadata | undefined = und
     }>>;
 }
 /**
- * Executes multiple asynchronous calls in parallel and collects the results in a easier to use format.
+ * Executes multiple asynchronous calls in parallel and collects the results in
+ * a easier to use format.
  *
+ * @deprecated Use concurrentAsyncCalls instead.
  * @template R - The type of the result value.
  * @template M - The type of the call metadata.
- *
- * @deprecated Use concurrentAsyncCalls instead.
  */
 declare function parallelAsyncCalls<M extends ValidMetadata | undefined = undefined, R = unknown>(): ParallelAsyncResultCalls<M, R>;
 

package/dist/parallelAsyncCalls.d.ts

@@ -38,7 +38,8 @@ declare class ParallelAsyncResultCalls<M extends ValidMetadata | undefined = und
         fn: () => Promise<Result<R>>;
     }): this;
     /**
-     * adds calls return tuples with inferred results
+     * Adds calls return tuples with inferred results
+     *
      * @param calls
      */
     addTuple<T extends (M extends undefined ? () => Promise<Result<R>> : {
@@ -69,12 +70,12 @@ declare class ParallelAsyncResultCalls<M extends ValidMetadata | undefined = und
     }>>;
 }
 /**
- * Executes multiple asynchronous calls in parallel and collects the results in a easier to use format.
+ * Executes multiple asynchronous calls in parallel and collects the results in
+ * a easier to use format.
  *
+ * @deprecated Use concurrentAsyncCalls instead.
  * @template R - The type of the result value.
  * @template M - The type of the call metadata.
- *
- * @deprecated Use concurrentAsyncCalls instead.
  */
 declare function parallelAsyncCalls<M extends ValidMetadata | undefined = undefined, R = unknown>(): ParallelAsyncResultCalls<M, R>;
 

package/dist/parallelAsyncCalls.js

@@ -21,7 +21,8 @@ var ParallelAsyncResultCalls = class {
     return this;
   }
   /**
-   * adds calls return tuples with inferred results
+   * Adds calls return tuples with inferred results
+   *
    * @param calls
    */
   addTuple(...calls) {

package/dist/retryOnError.d.cts

@@ -1,12 +1,13 @@
 import { ResultValidErrors, Result } from 't-result';
 
-/**
- * Configuration options for retryOnError function.
- */
+/** Configuration options for retryOnError function. */
 type RetryOptions = {
     /** Delay between retries in milliseconds or function returning delay */
     delayBetweenRetriesMs?: number | ((retry: number) => number);
-    /** Function to determine if retry should happen, receives error and duration of last attempt */
+    /**
+     * Function to determine if retry should happen, receives error and duration
+     * of last attempt
+     */
     retryCondition?: (error: Error, lastAttempt: {
         duration: number;
         retry: number;
@@ -24,22 +25,23 @@ type RetryOptions = {
 /**
  * Retries a function on error with configurable retry logic.
  *
+ * @example
+ *   await retryOnError(
+ *     async (ctx) => {
+ *       console.log(`Attempt ${ctx.retry + 1}`);
+ *       return await fetchData();
+ *     },
+ *     3,
+ *     { delayBetweenRetriesMs: 1000 },
+ *   );
+ *
  * @param fn - Function to retry that receives context with retry count
  * @param maxRetries - Maximum number of retries
  * @param options - Configuration options
- * @param retry - internal use only
- * @param originalMaxRetries - internal use only
- * @returns Promise resolving to the function result or rejecting with the final error
- *
- * @example
- * await retryOnError(
- *   async (ctx) => {
- *     console.log(`Attempt ${ctx.retry + 1}`);
- *     return await fetchData();
- *   },
- *   3,
- *   { delayBetweenRetriesMs: 1000 }
- * );
+ * @param retry - Internal use only
+ * @param originalMaxRetries - Internal use only
+ * @returns Promise resolving to the function result or rejecting with the final
+ *   error
  */
 declare function retryOnError<T>(fn: (ctx: {
     /** Current retry count, (0 for first attempt) */
@@ -56,9 +58,10 @@ declare function retryOnError<T>(fn: (ctx: {
  * @param options.debugId
  * @param options.disableRetries
  * @param options.onRetry
- * @param __retry - internal use only
- * @param __originalMaxRetries - internal use only
- * @returns Promise resolving to the function result or rejecting with the final error
+ * @param __retry - Internal use only
+ * @param __originalMaxRetries - Internal use only
+ * @returns Promise resolving to the function result or rejecting with the final
+ *   error
  */
 declare function retryResultOnError<T, E extends ResultValidErrors>(fn: (ctx: {
     /** Current retry count, (0 for first attempt) */