@futdevpro/fsm-dynamo 1.14.10 → 1.14.12

package/build/_collections/utils/array.util.js

@@ -7,6 +7,14 @@ class DyFM_Array {
      * @param list - The array to iterate over.
      * @param func - The function to apply to each element.
      * @returns A promise that resolves when all elements have been processed.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * await DyFM_Array.asyncForEach(list, async (element: number, index?: number, array?: number[]): Promise<void> => {
+     *   console.log(element, index, array);
+     * });
+     * ```
      */
     static async asyncForEach(list, func) {
         for (let i = 0; i < list.length; i++) {
@@ -19,6 +27,14 @@ class DyFM_Array {
      * @param list - The array to iterate over.
      * @param func - The function to apply to each element.
      * @returns A promise that resolves to the final result.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = await DyFM_Array.asyncForEachReturnToOne(0, list, async (element: number, dataCurrent: number, index?: number, array?: number[]): Promise<number> => {
+     *   return dataCurrent + element;
+     * });
+     * ```
      */
     static async asyncForEachReturnToOne(startData, list, func) {
         let result = startData;
@@ -32,6 +48,14 @@ class DyFM_Array {
      * @param list - The array to iterate over.
      * @param func - The function to apply to each element.
      * @returns A promise that resolves to an array of results.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = await DyFM_Array.asyncForEachReturnToAll(list, async (element: number, index?: number, array?: number[]): Promise<number> => {
+     *   return element * 2;
+     * });
+     * ```
      */
     static async asyncForEachReturnToAll(list, func) {
         const resultList = [];
@@ -45,6 +69,15 @@ class DyFM_Array {
      * @param list - The array to iterate over.
      * @param func - The function to apply to each element.
      * @returns A promise that resolves to an array of results.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = await DyFM_Array.asyncForEachAllAtOnce(list, async (element: number, index?: number, array?: number[]): Promise<number> => {
+     *   return [ element * 2, element * 3 ];
+     * });
+     * console.log(result); // [ [ 2, 3 ], [ 4, 6 ], [ 6, 9 ] ]
+     * ```
      */
     static async asyncForEachAllAtOnce(list, func) {
         return await Promise.all(list.map(func));
@@ -54,6 +87,15 @@ class DyFM_Array {
      * @param list - The array to filter.
      * @param filterFunc - The function to apply to each element.
      * @returns A promise that resolves to an array of results.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = await DyFM_Array.asyncFilter(list, async (element: number, index?: number, array?: number[]): Promise<boolean> => {
+     *   return element % 2 === 0;
+     * });
+     * console.log(result); // [ 2 ]
+     * ```
      */
     static async asyncFilter(list, filterFunc) {
         const resultList = [];
@@ -69,6 +111,15 @@ class DyFM_Array {
      * @param list - The array to map.
      * @param mapFunc - The function to apply to each element.
      * @returns A promise that resolves to an array of results.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = await DyFM_Array.asyncMap(list, async (element: number, index?: number, array?: number[]): Promise<number> => {
+     *   return element * 2;
+     * });
+     * console.log(result); // [ 2, 4, 6 ]
+     * ```
      */
     static async asyncMap(list, mapFunc) {
         const resultList = [];
@@ -81,6 +132,13 @@ class DyFM_Array {
      * Returns the last element of an array.
      * @param array - The array to get the last element from.
      * @returns The last element of the array, or null if the array is empty.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.last(list);
+     * console.log(result); // 3
+     * ```
      */
     static last(array) {
         return array?.length ? array[array.length - 1] : null;
@@ -90,6 +148,13 @@ class DyFM_Array {
      * @param string - The string to check.
      * @param array - The array to check.
      * @returns True if the string is the last element of the array, false otherwise.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.isLast(3, list);
+     * console.log(result); // true
+     * ```
      */
     static isLast(element, array) {
         return array.indexOf(element) === array.length - 1;
@@ -99,6 +164,13 @@ class DyFM_Array {
      * @param string - The string to check.
      * @param array - The array to check.
      * @returns True if the string is the last element of the array, false otherwise.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.isLastIndex(2, list);
+     * console.log(result); // true
+     * ```
      */
     static isLastIndex(index, array) {
         return index === array.length - 1;
@@ -108,6 +180,13 @@ class DyFM_Array {
      * @param string - The string to check.
      * @param array - The array to check.
      * @returns True if the string is the first element of the array, false otherwise.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.isFirst(1, list);
+     * console.log(result); // true
+     * ```
      */
     static isFirst(element, array) {
         return array.indexOf(element) === 0;
@@ -116,6 +195,13 @@ class DyFM_Array {
      * Returns the last character of a string.
      * @param string - The string to get the last character from.
      * @returns The last character of the string, or null if the string is empty.
+     *
+     * @example
+     * ```ts
+     * const string = 'hello';
+     * const result = DyFM_Array.lastCharacter(string);
+     * console.log(result); // 'o'
+     * ```
      */
     static lastCharacter(string) {
         return string?.length ? string[string.length - 1] : null;
@@ -124,6 +210,13 @@ class DyFM_Array {
      * Returns the first element of an array.
      * @param array - The array to get the first element from.
      * @returns The first element of the array, or null if the array is empty.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.first(list);
+     * console.log(result); // 1
+     * ```
      */
     static first(array) {
         return array?.length ? array[0] : null;
@@ -133,6 +226,13 @@ class DyFM_Array {
      * @param array - The array to remove the element from.
      * @param element - The element to remove from the array.
      * @returns The array with the element removed.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.remove(list, 2);
+     * console.log(result); // [ 1, 3 ]
+     * ```
      */
     static remove(array, element) {
         const index = array.indexOf(element);
@@ -146,6 +246,15 @@ class DyFM_Array {
      * @param array - The array to find and remove the element from.
      * @param func - The function to apply to each element.
      * @returns The array with the element removed.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.findNRemove(list, (element: number, index?: number, array?: number[]): boolean => {
+     *   return element === 2;
+     * });
+     * console.log(result); // [ 1, 3 ]
+     * ```
      */
     static findNRemove(array, func) {
         const index = array.findIndex(func);
@@ -158,6 +267,13 @@ class DyFM_Array {
      * Shuffles an array.
      * @param array - The array to shuffle.
      * @returns The shuffled array.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.shuffle(list);
+     * console.log(result); // [ 3, 1, 2 ]
+     * ```
      */
     static shuffle(array) {
         let currentIndex = array.length;
@@ -175,6 +291,13 @@ class DyFM_Array {
      * @param pageIndex - The index of the page to return.
      * @param pageSize - The size of the page.
      * @returns The page of the array.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3, 4, 5, 6, 7, 8 ];
+     * const result = DyFM_Array.page(list, 0, 2);
+     * console.log(result); // [ 1, 2 ]
+     * ```
      */
     static page(array, pageIndex, pageSize) {
         return array.slice(pageIndex * pageSize, (pageIndex + 1) * pageSize);
@@ -185,6 +308,13 @@ class DyFM_Array {
      * @param pageIndex - The index of the page to return.
      * @param pageSize - The size of the page.
      * @returns The page of the array.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3, 4, 5, 6, 7, 8 ];
+     * const result = DyFM_Array.paged(list, 0, 2);
+     * console.log(result); // { pageIndex: 0, pageSize: 2, total: 8, totalPageCount: 4, items: [ 1, 2 ] }
+     * ```
      */
     static paged(array, pageIndex, pageSize) {
         return {
@@ -201,6 +331,13 @@ class DyFM_Array {
      * @param indexA - The index of the first element to swap.
      * @param indexB - The index of the second element to swap.
      * @returns The array with the elements swapped.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.swap(list, 0, 2);
+     * console.log(result); // [ 3, 2, 1 ]
+     * ```
      */
     static swap(array, indexA, indexB) {
         [array[indexA], array[indexB]] = [array[indexB], array[indexA]];
@@ -210,6 +347,13 @@ class DyFM_Array {
      * Checks if a string list has multiplications.
      * @param stringList - The string list to check.
      * @returns True if the string list has multiplications, false otherwise.
+     *
+     * @example
+     * ```ts
+     * const list: string[] = [ 'a', 'b', 'c', 'a' ];
+     * const result = DyFM_Array.stringListHasMultiplications(list);
+     * console.log(result); // true
+     * ```
      */
     static stringListHasMultiplications(stringList) {
         return stringList.some((str, index) => {
@@ -220,6 +364,13 @@ class DyFM_Array {
      * Filters a string list to remove multiplications.
      * @param stringList - The string list to filter.
      * @returns The filtered string list.
+     *
+     * @example
+     * ```ts
+     * const list: string[] = [ 'a', 'b', 'c', 'a' ];
+     * const result = DyFM_Array.filterStringMultiplications(list);
+     * console.log(result); // [ 'a', 'b', 'c' ]
+     * ```
      */
     static filterStringMultiplications(stringList) {
         return stringList.filter((str, index) => {
@@ -230,6 +381,13 @@ class DyFM_Array {
      * Gathers multiplications from a string list.
      * @param stringList - The string list to gather multiplications from.
      * @returns The gathered multiplications.
+     *
+     * @example
+     * ```ts
+     * const list: string[] = [ 'a', 'b', 'c', 'a' ];
+     * const result = DyFM_Array.gatherStringMultiplications(list);
+     * console.log(result); // [ [ 'a', 'a' ] ]
+     * ```
      */
     static gatherStringMultiplications(stringList) {
         const multiplications = [];
@@ -249,6 +407,13 @@ class DyFM_Array {
      * @param dataList - The data list to check.
      * @param byKey - The key to check for multiplications.
      * @returns True if the data list has multiplications, false otherwise.
+     *
+     * @example
+     * ```ts
+     * const list: { _id: number, name: string }[] = [ { _id: 1, name: 'John' }, { _id: 2, name: 'Jane' }, { _id: 1, name: 'Bob' } ];
+     * const result = DyFM_Array.haveMultiplications(list, '_id');
+     * console.log(result); // true
+     * ```
      */
     static haveMultiplications(dataList, byKey = '_id') {
         return dataList.some((data, index) => {
@@ -260,6 +425,13 @@ class DyFM_Array {
      * @param dataList - The data list to filter.
      * @param byKey - The key to filter for multiplications.
      * @returns The filtered data list.
+     *
+     * @example
+     * ```ts
+     * const list: { _id: number, name: string }[] = [ { _id: 1, name: 'John' }, { _id: 2, name: 'Jane' }, { _id: 1, name: 'Bob' } ];
+     * const result = DyFM_Array.filterMultiplications(list, '_id');
+     * console.log(result); // [ { _id: 1, name: 'John' } , { _id: 2, name: 'Jane' } ]
+     * ```
      */
     static filterMultiplications(dataList, byKey = '_id') {
         return dataList.filter((data, index) => {
@@ -271,6 +443,13 @@ class DyFM_Array {
      * @param dataList - The data list to gather multiplications from.
      * @param byKey - The key to gather multiplications from.
      * @returns The gathered multiplications.
+     *
+     * @example
+     * ```ts
+     * const list: { _id: number, name: string }[] = [ { _id: 1, name: 'John' }, { _id: 2, name: 'Jane' }, { _id: 1, name: 'Bob' } ];
+     * const result = DyFM_Array.gatherMultiplications(list, '_id');
+     * console.log(result); // [ [ { _id: 1, name: 'John' }, { _id: 1, name: 'Bob' } ] ]
+     * ```
      */
     static gatherMultiplications(dataList, byKey = '_id') {
         const multiplications = [];
@@ -290,6 +469,15 @@ class DyFM_Array {
      * @param array - The array to find the element in.
      * @param func - The function to apply to each element.
      * @returns The element found, or null if no element is found.
+     *
+     * @example
+     * ```ts
+     * const list: number[] = [ 1, 2, 3 ];
+     * const result = DyFM_Array.findFromEnd(list, (element: number, index?: number, array?: number[]): boolean => {
+     *   return element === 2;
+     * });
+     * console.log(result); // 2
+     * ```
      */
     static findFromEnd(array, func) {
         for (let i = array.length - 1; i >= 0; i--) {
@@ -304,6 +492,7 @@ class DyFM_Array {
      * sorts so that the objects that have the value true for the checkFor function are at the beginning of the array
      * @param checkFor
      * @returns
+     *
      */
     static getSortForTrueFn(checkFor) {
         return (a, b) => this.sortForTrue(a, b, checkFor);

package/build/_collections/utils/array.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"array.util.js","sourceRoot":"","sources":["../../../src/_collections/utils/array.util.ts"],"names":[],"mappings":";;;AAWA,MAAa,UAAU;IAErB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CACvB,IAAS,EACT,IAAgE;QAEhE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAClC,SAAY,EACZ,IAAS,EACT,IAA6E;QAE7E,IAAI,MAAM,GAAM,SAAS,CAAC;QAE1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAClC,IAAS,EACT,IAA6D;QAE7D,MAAM,UAAU,GAAQ,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAChC,IAAS,EACT,IAA6D;QAE7D,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CACtB,IAAS,EACT,UAAyE;QAEzE,MAAM,UAAU,GAAQ,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,IAAI,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,IAAS,EACT,OAAgE;QAEhE,MAAM,UAAU,GAAQ,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,UAAU,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAI,KAAU;QACvB,OAAO,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAI,OAAU,EAAE,KAAU;QACrC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAI,KAAa,EAAE,KAAU;QAC7C,OAAO,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAI,OAAU,EAAE,KAAU;QACtC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,MAAc;QACjC,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAI,KAAU;QACxB,OAAO,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAI,KAAU,EAAE,OAAU;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAChB,KAAU,EACV,IAA0D;QAE1D,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEpC,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAI,KAAU;QAC1B,IAAI,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC;QAChC,IAAI,WAAmB,CAAC;QAExB,OAAO,CAAC,GAAG,YAAY,EAAE,CAAC;YACxB,YAAY,EAAE,CAAC;YAEf,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAI,KAAU,EAAE,SAAiB,EAAE,QAAgB;QAC5D,OAAO,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,QAAQ,EAAE,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAI,KAAU,EAAE,SAAiB,EAAE,QAAgB;QAC7D,OAAO;YACL,SAAS;YACT,QAAQ;YACR,KAAK,EAAE,KAAK,CAAC,MAAM;YACnB,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC;YAClD,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC;SAC7C,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAI,KAAU,EAAE,MAAc,EAAE,MAAc;QACvD,CAAE,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAE,GAAG,CAAE,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAE,CAAC;QAEpE,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,4BAA4B,CAAC,UAAoB;QACtD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,GAAW,EAAE,KAAa,EAAW,EAAE;YAC7D,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,KAAK,KAAK,CAAC;QACvF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAAC,UAAoB;QACrD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,KAAa,EAAW,EAAE;YAC/D,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,KAAK,KAAK,CAAC;QACvF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAAC,UAAoB;QACrD,MAAM,eAAe,GAAe,EAAE,CAAC;QAEvC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,KAAa,EAAQ,EAAE;YACtD,IAAI,eAAe,CAAC,IAAI,CACtB,CAAC,cAAwB,EAAW,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACpE,CAAC;gBACD,OAAO;YACT,CAAC;YAED,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC;YAErF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACpC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,mBAAmB,CAAmB,QAAa,EAAE,QAAiB,KAAgB;QAC3F,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAO,EAAE,KAAa,EAAW,EAAE;YACvD,OAAO,QAAQ,CAAC,SAAS,CACvB,CAAC,QAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAC1D,KAAK,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAmB,QAAa,EAAE,QAAiB,KAAgB;QAC7F,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAO,EAAE,KAAa,EAAW,EAAE;YACzD,OAAO,QAAQ,CAAC,SAAS,CACvB,CAAC,QAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAC1D,KAAK,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAmB,QAAa,EAAE,QAAiB,KAAgB;QAC7F,MAAM,eAAe,GAAU,EAAE,CAAC;QAElC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAO,EAAE,KAAa,EAAQ,EAAE;YAChD,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,cAAmB,EAAW,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC1F,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5F,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAChB,KAAU,EACV,IACuB;QAEvB,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CACrB,QAA2B;QAE3B,OAAO,CAAC,CAAI,EAAE,CAAI,EAAsB,EAAE,CAAC,IAAI,CAAC,WAAW,CAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACjF,CAAC;IAGD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,CAChB,CAAI,EACJ,CAAI,EACJ,KAAwB;QAExB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAErB,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,CAAC,CAAC;QACX,CAAC;aAAM,IAAI,GAAG,EAAE,CAAC;YACf,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;CACF;AApaD,gCAoaC"}
+{"version":3,"file":"array.util.js","sourceRoot":"","sources":["../../../src/_collections/utils/array.util.ts"],"names":[],"mappings":";;;AAWA,MAAa,UAAU;IAErB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CACvB,IAAS,EACT,IAAgE;QAEhE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAClC,SAAY,EACZ,IAAS,EACT,IAA6E;QAE7E,IAAI,MAAM,GAAM,SAAS,CAAC;QAE1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAClC,IAAS,EACT,IAA6D;QAE7D,MAAM,UAAU,GAAQ,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,UAAU,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAChC,IAAS,EACT,IAA6D;QAE7D,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CACtB,IAAS,EACT,UAAyE;QAEzE,MAAM,UAAU,GAAQ,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,IAAI,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;gBACvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3B,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,IAAS,EACT,OAAgE;QAEhE,MAAM,UAAU,GAAQ,EAAE,CAAC;QAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,UAAU,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,CAAI,KAAU;QACvB,OAAO,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CAAI,OAAU,EAAE,KAAU;QACrC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,WAAW,CAAI,KAAa,EAAE,KAAU;QAC7C,OAAO,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,OAAO,CAAI,OAAU,EAAE,KAAU;QACtC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,aAAa,CAAC,MAAc;QACjC,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAI,KAAU;QACxB,OAAO,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CAAI,KAAU,EAAE,OAAU;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,WAAW,CAChB,KAAU,EACV,IAA0D;QAE1D,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAEpC,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,OAAO,CAAI,KAAU;QAC1B,IAAI,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC;QAChC,IAAI,WAAmB,CAAC;QAExB,OAAO,CAAC,GAAG,YAAY,EAAE,CAAC;YACxB,YAAY,EAAE,CAAC;YAEf,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAI,KAAU,EAAE,SAAiB,EAAE,QAAgB;QAC5D,OAAO,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,QAAQ,EAAE,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAI,KAAU,EAAE,SAAiB,EAAE,QAAgB;QAC7D,OAAO;YACL,SAAS;YACT,QAAQ;YACR,KAAK,EAAE,KAAK,CAAC,MAAM;YACnB,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC;YAClD,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC;SAC7C,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,CAAI,KAAU,EAAE,MAAc,EAAE,MAAc;QACvD,CAAE,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAE,GAAG,CAAE,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAE,CAAC;QAEpE,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,4BAA4B,CAAC,UAAoB;QACtD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,GAAW,EAAE,KAAa,EAAW,EAAE;YAC7D,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,KAAK,KAAK,CAAC;QACvF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,2BAA2B,CAAC,UAAoB;QACrD,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,KAAa,EAAW,EAAE;YAC/D,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,KAAK,KAAK,CAAC;QACvF,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,2BAA2B,CAAC,UAAoB;QACrD,MAAM,eAAe,GAAe,EAAE,CAAC;QAEvC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,KAAa,EAAQ,EAAE;YACtD,IAAI,eAAe,CAAC,IAAI,CACtB,CAAC,cAAwB,EAAW,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EACpE,CAAC;gBACD,OAAO;YACT,CAAC;YAED,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,OAAe,EAAW,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC;YAErF,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACpC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,mBAAmB,CAAmB,QAAa,EAAE,QAAiB,KAAgB;QAC3F,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAO,EAAE,KAAa,EAAW,EAAE;YACvD,OAAO,QAAQ,CAAC,SAAS,CACvB,CAAC,QAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAC1D,KAAK,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,qBAAqB,CAAmB,QAAa,EAAE,QAAiB,KAAgB;QAC7F,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAO,EAAE,KAAa,EAAW,EAAE;YACzD,OAAO,QAAQ,CAAC,SAAS,CACvB,CAAC,QAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAC1D,KAAK,KAAK,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,qBAAqB,CAAmB,QAAa,EAAE,QAAiB,KAAgB;QAC7F,MAAM,eAAe,GAAU,EAAE,CAAC;QAElC,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAO,EAAE,KAAa,EAAQ,EAAE;YAChD,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,cAAmB,EAAW,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC1F,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAW,EAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5F,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxB,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,WAAW,CAChB,KAAU,EACV,IACuB;QAEvB,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,gBAAgB,CACrB,QAA2B;QAE3B,OAAO,CAAC,CAAI,EAAE,CAAI,EAAsB,EAAE,CAAC,IAAI,CAAC,WAAW,CAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACjF,CAAC;IAGD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,CAChB,CAAI,EACJ,CAAI,EACJ,KAAwB;QAExB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAErB,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,CAAC,CAAC;QACX,CAAC;aAAM,IAAI,GAAG,EAAE,CAAC;YACf,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;CACF;AAjmBD,gCAimBC"}

package/build/_collections/utils/async.util.d.ts

@@ -4,6 +4,11 @@ export declare class DyFM_Async {
      * delays the execution of a function
      * @param ms
      * @returns
+     *
+     * @example
+     * ```ts
+     * await DyFM_Async.wait(1000);
+     * ```
      */
     static wait(ms: number): Promise<void>;
     static readonly sleep: typeof this.wait;
@@ -11,6 +16,11 @@ export declare class DyFM_Async {
     /**
      * WARNING: This function is recommended to use ONLY for limited instances,
      * because it can cause performance issues.
+     *
+     * @example
+     * ```ts
+     * await DyFM_Async.waitUntil(() => check(), 100, 10000);
+     * ```
      */
     static waitUntil(check: () => boolean, interval?: number, timeout?: number): Promise<void>;
     /**
@@ -27,8 +37,27 @@ export declare class DyFM_Async {
     static waitUntilAsync(check: () => Promise<boolean>, interval?: number, timeout?: number): Promise<void>;
     /**
      * Creates a promise that resolves when the observable emits a value that passes the check function
+     *
+     * @example
+     * ```ts
+     * const observable = new Observable<number>(observer => {
+     *   setInterval(() => observer.next(Math.random()), 100);
+     * });
+     * const result = await DyFM_Async.takeUntil(observable, (value?: number) => value && value > 0.5);
+     * ```
      */
     static takeUntil<T>(observable: Observable<T>, check: (value?: T) => boolean): Promise<T>;
+    /**
+     * Waits for a given amount of time and logs the remaining time.
+     * @param totalWaitTimeMs - The total amount of time to wait.
+     * @param context - The context of the countdown.
+     * @returns A promise that resolves when the countdown is complete.
+     *
+     * @example
+     * ```ts
+     * await DyFM_Async.waitWithCountdownLogging(1000, 'Countdown');
+     * ```
+     */
     static waitWithCountdownLogging(totalWaitTimeMs: number, context?: string): Promise<void>;
 }
 //# sourceMappingURL=async.util.d.ts.map

package/build/_collections/utils/async.util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"async.util.d.ts","sourceRoot":"","sources":["../../../src/_collections/utils/async.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAMlC,qBAAa,UAAU;IAErB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAGtC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,IAAI,CAAa;IACpD,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,IAAI,CAAa;IAEpD;;;OAGG;IACH,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,MAAM,OAAO,EACpB,QAAQ,GAAE,MAAY,EACtB,OAAO,GAAE,MAAe,GACvB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,cAAc,CACnB,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC7B,QAAQ,GAAE,MAAY,EACtB,OAAO,GAAE,MAAc,GACtB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAChB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO,GAC5B,OAAO,CAAC,CAAC,CAAC;WAaA,wBAAwB,CACnC,eAAe,EAAE,MAAM,EACvB,OAAO,GAAE,MAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC;CAuDjB"}
+{"version":3,"file":"async.util.d.ts","sourceRoot":"","sources":["../../../src/_collections/utils/async.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAMlC,qBAAa,UAAU;IAErB;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAGtC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,IAAI,CAAa;IACpD,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,IAAI,CAAC,IAAI,CAAa;IAEpD;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CACd,KAAK,EAAE,MAAM,OAAO,EACpB,QAAQ,GAAE,MAAY,EACtB,OAAO,GAAE,MAAe,GACvB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,cAAc,CACnB,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC7B,QAAQ,GAAE,MAAY,EACtB,OAAO,GAAE,MAAc,GACtB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAChB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,OAAO,GAC5B,OAAO,CAAC,CAAC,CAAC;IAab;;;;;;;;;;OAUG;WACU,wBAAwB,CACnC,eAAe,EAAE,MAAM,EACvB,OAAO,GAAE,MAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC;CAkEjB"}

package/build/_collections/utils/async.util.js

@@ -1,4 +1,5 @@
 "use strict";
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DyFM_Async = void 0;
 const times_const_1 = require("../constants/times.const");
@@ -9,15 +10,23 @@ class DyFM_Async {
      * delays the execution of a function
      * @param ms
      * @returns
+     *
+     * @example
+     * ```ts
+     * await DyFM_Async.wait(1000);
+     * ```
      */
     static wait(ms) {
         return new Promise((resolve) => setTimeout(resolve, ms));
     }
-    static sleep = this.wait;
-    static delay = this.wait;
     /**
      * WARNING: This function is recommended to use ONLY for limited instances,
      * because it can cause performance issues.
+     *
+     * @example
+     * ```ts
+     * await DyFM_Async.waitUntil(() => check(), 100, 10000);
+     * ```
      */
     static waitUntil(check, interval = 100, timeout = 10_000) {
         const timeoutError = new Error('waitUntil timeout');
@@ -64,6 +73,14 @@ class DyFM_Async {
     }
     /**
      * Creates a promise that resolves when the observable emits a value that passes the check function
+     *
+     * @example
+     * ```ts
+     * const observable = new Observable<number>(observer => {
+     *   setInterval(() => observer.next(Math.random()), 100);
+     * });
+     * const result = await DyFM_Async.takeUntil(observable, (value?: number) => value && value > 0.5);
+     * ```
      */
     static takeUntil(observable, check) {
         return new Promise((resolve) => {
@@ -75,10 +92,32 @@ class DyFM_Async {
             });
         });
     }
+    /**
+     * Waits for a given amount of time and logs the remaining time.
+     * @param totalWaitTimeMs - The total amount of time to wait.
+     * @param context - The context of the countdown.
+     * @returns A promise that resolves when the countdown is complete.
+     *
+     * @example
+     * ```ts
+     * await DyFM_Async.waitWithCountdownLogging(1000, 'Countdown');
+     * ```
+     */
     static async waitWithCountdownLogging(totalWaitTimeMs, context = 'Countdown') {
         const startTime = Date.now();
         const endTime = startTime + totalWaitTimeMs;
         // Define logging intervals based on total duration
+        /**
+         * Gets the logging interval based on the total duration.
+         * @param totalMs - The total duration in milliseconds.
+         * @returns The logging interval in milliseconds.
+         *
+         * @example
+         * ```ts
+         * const logInterval = getLogInterval(1000);
+         * console.log(logInterval); // 1000
+         * ```
+         */
         const getLogInterval = (totalMs) => {
             const totalSeconds = totalMs / times_const_1.second;
             const totalMinutes = totalSeconds / 60;
@@ -129,11 +168,14 @@ class DyFM_Async {
                 lastLogTime = now;
             }
             // Wait for a short interval before checking again
-            await DyFM_Async.wait(Math.min(time_util_1.DyFM_Time.second, remainingMs));
+            await _a.wait(Math.min(time_util_1.DyFM_Time.second, remainingMs));
         }
         // Log completion
         log_util_1.DyFM_Log.success(`✅ ${context} completed`);
     }
 }
 exports.DyFM_Async = DyFM_Async;
+_a = DyFM_Async;
+DyFM_Async.sleep = _a.wait;
+DyFM_Async.delay = _a.wait;
 //# sourceMappingURL=async.util.js.map

package/build/_collections/utils/async.util.js.map

@@ -1 +1 @@
-{"version":3,"file":"async.util.js","sourceRoot":"","sources":["../../../src/_collections/utils/async.util.ts"],"names":[],"mappings":";;;AACA,0DAA2E;AAC3E,2CAAwC;AACxC,yCAAsC;AAGtC,MAAa,UAAU;IAErB;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,EAAU;QACpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAO,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,CAAU,KAAK,GAAqB,IAAI,CAAC,IAAI,CAAC;IACpD,MAAM,CAAU,KAAK,GAAqB,IAAI,CAAC,IAAI,CAAC;IAEpD;;;OAGG;IACH,MAAM,CAAC,SAAS,CACd,KAAoB,EACpB,WAAmB,GAAG,EACtB,UAAkB,MAAM;QAExB,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAEpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,MAAM,UAAU,GAAG,WAAW,CAAC,GAAS,EAAE;gBACxC,IAAI,KAAK,EAAE,EAAE,CAAC;oBACZ,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC;oBAC5C,aAAa,CAAC,UAAU,CAAC,CAAC;oBAE1B,MAAM,CAAC,YAAY,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,EAAE,QAAQ,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,cAAc,CACnB,KAA6B,EAC7B,WAAmB,GAAG,EACtB,UAAkB,KAAK;QAEvB,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAEzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,IAAmB,EAAE;gBACvD,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;oBAClB,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC;oBAC5C,aAAa,CAAC,UAAU,CAAC,CAAC;oBAE1B,MAAM,CAAC,YAAY,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,EAAE,QAAQ,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CACd,UAAyB,EACzB,KAA6B;QAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAQ,EAAE;YACnC,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAC9B,CAAC,KAAS,EAAQ,EAAE;gBAClB,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjB,GAAG,CAAC,WAAW,EAAE,CAAC;oBAClB,OAAO,CAAC,KAAU,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,wBAAwB,CACnC,eAAuB,EACvB,UAAkB,WAAW;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,SAAS,GAAG,eAAe,CAAC;QAE5C,mDAAmD;QACnD,MAAM,cAAc,GAAG,CAAC,OAAe,EAAU,EAAE;YACjD,MAAM,YAAY,GAAG,OAAO,GAAG,oBAAM,CAAC;YACtC,MAAM,YAAY,GAAG,YAAY,GAAG,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,YAAY,GAAG,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,UAAU,GAAG,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,SAAS,GAAG,CAAC,CAAC;YAEjC,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,kBAAI,CAAC,CAAC,aAAa;YAC/C,IAAI,SAAS,IAAI,CAAC;gBAAE,OAAO,iBAAG,CAAC,CAAC,YAAY;YAC5C,IAAI,SAAS,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,kBAAI,CAAC,CAAC,iBAAiB;YACvD,IAAI,SAAS,IAAI,CAAC;gBAAE,OAAO,CAAC,GAAG,kBAAI,CAAC,CAAC,gBAAgB;YACrD,IAAI,UAAU,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,kBAAI,CAAC,CAAC,gBAAgB;YACvD,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,kBAAI,CAAC,CAAC,aAAa;YAC/C,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC5D,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC5D,IAAI,YAAY,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,oBAAM,CAAC,CAAC,kBAAkB;YAC7D,IAAI,YAAY,IAAI,EAAE;gBAAE,OAAO,oBAAM,CAAC,CAAC,eAAe;YACtD,IAAI,YAAY,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC9D,IAAI,YAAY,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC9D,IAAI,YAAY,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,oBAAM,CAAC,CAAC,kBAAkB;YAC7D,OAAO,oBAAM,CAAC,CAAC,eAAe;QAChC,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;QACpD,IAAI,WAAW,GAAG,SAAS,CAAC;QAE5B,4DAA4D;QAC5D,MAAM,mBAAmB,GAAG,CAAC,WAAmB,EAAU,EAAE,CAAC,qBAAS,CAAC,uBAAuB,CAAC,WAAW,CAAW,CAAC;QAEtH,8BAA8B;QAC9B,mBAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,8BAA8B,mBAAmB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAEhG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,OAAO,GAAG,GAAG,CAAC;YAElC,4BAA4B;YAC5B,IAAI,GAAG,GAAG,WAAW,IAAI,WAAW,EAAE,CAAC;gBACrC,MAAM,aAAa,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;gBACvD,mBAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,MAAM,aAAa,YAAY,CAAC,CAAC;gBAC3D,WAAW,GAAG,GAAG,CAAC;YACpB,CAAC;YAED,kDAAkD;YAClD,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;QACjE,CAAC;QAED,iBAAiB;QACjB,mBAAQ,CAAC,OAAO,CAAC,KAAK,OAAO,YAAY,CAAC,CAAC;IAC7C,CAAC;;AAtJH,gCAuJC"}
+{"version":3,"file":"async.util.js","sourceRoot":"","sources":["../../../src/_collections/utils/async.util.ts"],"names":[],"mappings":";;;;AACA,0DAA2E;AAC3E,2CAAwC;AACxC,yCAAsC;AAGtC,MAAa,UAAU;IAErB;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,CAAC,EAAU;QACpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAO,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;IAID;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CACd,KAAoB,EACpB,WAAmB,GAAG,EACtB,UAAkB,MAAM;QAExB,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAEpD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,MAAM,UAAU,GAAG,WAAW,CAAC,GAAS,EAAE;gBACxC,IAAI,KAAK,EAAE,EAAE,CAAC;oBACZ,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC;oBAC5C,aAAa,CAAC,UAAU,CAAC,CAAC;oBAE1B,MAAM,CAAC,YAAY,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,EAAE,QAAQ,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,cAAc,CACnB,KAA6B,EAC7B,WAAmB,GAAG,EACtB,UAAkB,KAAK;QAEvB,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAEzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAQ,EAAE;YAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,IAAmB,EAAE;gBACvD,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;oBAClB,aAAa,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO,EAAE,CAAC;gBACZ,CAAC;qBAAM,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC;oBAC5C,aAAa,CAAC,UAAU,CAAC,CAAC;oBAE1B,MAAM,CAAC,YAAY,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC,EAAE,QAAQ,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,CACd,UAAyB,EACzB,KAA6B;QAE7B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAQ,EAAE;YACnC,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAC9B,CAAC,KAAS,EAAQ,EAAE;gBAClB,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjB,GAAG,CAAC,WAAW,EAAE,CAAC;oBAClB,OAAO,CAAC,KAAU,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,CAAC,wBAAwB,CACnC,eAAuB,EACvB,UAAkB,WAAW;QAE7B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,SAAS,GAAG,eAAe,CAAC;QAE5C,mDAAmD;QACnD;;;;;;;;;;WAUG;QACH,MAAM,cAAc,GAAG,CAAC,OAAe,EAAU,EAAE;YACjD,MAAM,YAAY,GAAG,OAAO,GAAG,oBAAM,CAAC;YACtC,MAAM,YAAY,GAAG,YAAY,GAAG,EAAE,CAAC;YACvC,MAAM,UAAU,GAAG,YAAY,GAAG,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,UAAU,GAAG,EAAE,CAAC;YAClC,MAAM,UAAU,GAAG,SAAS,GAAG,CAAC,CAAC;YAEjC,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,kBAAI,CAAC,CAAC,aAAa;YAC/C,IAAI,SAAS,IAAI,CAAC;gBAAE,OAAO,iBAAG,CAAC,CAAC,YAAY;YAC5C,IAAI,SAAS,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,kBAAI,CAAC,CAAC,iBAAiB;YACvD,IAAI,SAAS,IAAI,CAAC;gBAAE,OAAO,CAAC,GAAG,kBAAI,CAAC,CAAC,gBAAgB;YACrD,IAAI,UAAU,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,kBAAI,CAAC,CAAC,gBAAgB;YACvD,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,kBAAI,CAAC,CAAC,aAAa;YAC/C,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC5D,IAAI,UAAU,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC5D,IAAI,YAAY,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,oBAAM,CAAC,CAAC,kBAAkB;YAC7D,IAAI,YAAY,IAAI,EAAE;gBAAE,OAAO,oBAAM,CAAC,CAAC,eAAe;YACtD,IAAI,YAAY,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC9D,IAAI,YAAY,IAAI,CAAC;gBAAE,OAAO,EAAE,GAAG,oBAAM,CAAC,CAAC,mBAAmB;YAC9D,IAAI,YAAY,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,oBAAM,CAAC,CAAC,kBAAkB;YAC7D,OAAO,oBAAM,CAAC,CAAC,eAAe;QAChC,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,CAAC;QACpD,IAAI,WAAW,GAAG,SAAS,CAAC;QAE5B,4DAA4D;QAC5D,MAAM,mBAAmB,GAAG,CAAC,WAAmB,EAAU,EAAE,CAAC,qBAAS,CAAC,uBAAuB,CAAC,WAAW,CAAW,CAAC;QAEtH,8BAA8B;QAC9B,mBAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,8BAA8B,mBAAmB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAEhG,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,OAAO,GAAG,GAAG,CAAC;YAElC,4BAA4B;YAC5B,IAAI,GAAG,GAAG,WAAW,IAAI,WAAW,EAAE,CAAC;gBACrC,MAAM,aAAa,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;gBACvD,mBAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,MAAM,aAAa,YAAY,CAAC,CAAC;gBAC3D,WAAW,GAAG,GAAG,CAAC;YACpB,CAAC;YAED,kDAAkD;YAClD,MAAM,EAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,qBAAS,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;QACjE,CAAC;QAED,iBAAiB;QACjB,mBAAQ,CAAC,OAAO,CAAC,KAAK,OAAO,YAAY,CAAC,CAAC;IAC7C,CAAC;;AA9LH,gCA+LC;;AAhLiB,gBAAK,GAAqB,EAAI,CAAC,IAAI,AAA9B,CAA+B;AACpC,gBAAK,GAAqB,EAAI,CAAC,IAAI,AAA9B,CAA+B"}

package/build/_collections/utils/json-error-helper.util.d.ts

@@ -29,10 +29,26 @@ export declare class DyFM_JsonErrorHelper {
      * @param jsonInput - The original JSON input string
      * @param contextLines - Number of context lines to show before and after the error (default: 5)
      * @returns Object containing line number, context lines, and character position, or null if parsing fails
+     *
+     * @example
+     * ```ts
+     * const lineInfo = DyFM_JsonErrorHelper.extractLineInfoFromJsonError('Expected property name or "}" in JSON at position 10', '{"name": "John", "age": 30}', 5);
+     * console.log(lineInfo); // { lineNumber: 1, contextLines: [ '{"name": "John", "age": 30}' ], characterPosition: 10 }
+     * ```
      */
     static extractLineInfoFromJsonError(errorMessage: string, jsonInput: string, contextLines?: number): JsonErrorLineInfo | null;
     /**
      * Helper method to create line info from a character position
+     * @param jsonInput - The original JSON input string
+     * @param position - The character position where the error occurred
+     * @param contextLines - Number of context lines to show before and after the error (default: 5)
+     * @returns Object containing line number, context lines, and character position
+     *
+     * @example
+     * ```ts
+     * const lineInfo = DyFM_JsonErrorHelper.createLineInfoFromPosition('{"name": "John", "age": 30}', 10, 5);
+     * console.log(lineInfo); // { lineNumber: 1, contextLines: [ '{"name": "John", "age": 30}' ], characterPosition: 10 }
+     * ```
      */
     private static createLineInfoFromPosition;
     /**
@@ -42,6 +58,12 @@ export declare class DyFM_JsonErrorHelper {
      * @param lineInfo - The line information extracted from the error
      * @param errorMessage - The original error message
      * @returns Formatted error string for logging
+     *
+     * @example
+     * ```ts
+     * const logLines = DyFM_JsonErrorHelper.formatJsonErrorForLogging({ lineNumber: 1, contextLines: [ '{"name": "John", "age": 30}' ], characterPosition: 10 }, 'Expected property name or "}" in JSON at position 10');
+     * console.log(logLines); // [ 'JSON parsing failed: Expected property name or "}" in JSON at position 10', 'Error at line 1, character 10:', 'Context (1 lines):', '    1: {"name": "John", "age": 30}' ]
+     * ```
      */
     static formatJsonErrorForLogging(lineInfo: JsonErrorLineInfo, errorMessage: string): string[];
     /**
@@ -53,10 +75,26 @@ export declare class DyFM_JsonErrorHelper {
      * @param contextLines - Number of context lines to show in error (default: 5)
      * @returns Parsed JSON object
      * @throws Error with detailed line information if parsing fails
+     *
+     * @example
+     * ```ts
+     * const json = '{"name": "John", "age": 30}';
+     * const result = DyFM_JsonErrorHelper.parseJsonWithEnhancedError(json);
+     * console.log(result); // { name: 'John', age: 30 }
+     * ```
      */
     static parseJsonWithEnhancedError(jsonString: string, reviver?: (key: string, value: any) => any, contextLines?: number): any;
     /**
      * Formats single-line JSON with line breaks for better error reporting
+     * @param jsonString - The JSON string to format
+     * @returns The formatted JSON string
+     *
+     * @example
+     * ```ts
+     * const json = '{"name": "John", "age": 30, "city": "New York"}';
+     * const result = DyFM_JsonErrorHelper.formatJsonForBetterErrors(json);
+     * console.log(result); // '{\n  "name": "John",\n  "age": 30,\n  "city": "New York"\n}'
+     * ```
      */
     private static formatJsonForBetterErrors;
 }

package/build/_collections/utils/json-error-helper.util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"json-error-helper.util.d.ts","sourceRoot":"","sources":["../../../src/_collections/utils/json-error-helper.util.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,sEAAsE;IACtE,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAE/B;;;;;;;;;OASG;IACH,MAAM,CAAC,4BAA4B,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,MAAU,GACvB,iBAAiB,GAAG,IAAI;IA+C3B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IA0DzC;;;;;;;OAOG;IACH,MAAM,CAAC,yBAAyB,CAC9B,QAAQ,EAAE,iBAAiB,EAC3B,YAAY,EAAE,MAAM,GACnB,MAAM,EAAE;IAoBX;;;;;;;;;OASG;IACH,MAAM,CAAC,0BAA0B,CAC/B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,EAC1C,YAAY,GAAE,MAAU,GACvB,GAAG;IA2CN;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;CAuBzC"}
+{"version":3,"file":"json-error-helper.util.d.ts","sourceRoot":"","sources":["../../../src/_collections/utils/json-error-helper.util.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,sEAAsE;IACtE,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAE/B;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,4BAA4B,CACjC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,MAAU,GACvB,iBAAiB,GAAG,IAAI;IA+C3B;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IA0DzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,yBAAyB,CAC9B,QAAQ,EAAE,iBAAiB,EAC3B,YAAY,EAAE,MAAM,GACnB,MAAM,EAAE;IAoBX;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,0BAA0B,CAC/B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,EAC1C,YAAY,GAAE,MAAU,GACvB,GAAG;IA4CN;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;CAwBzC"}