@creejs/commons-lang 2.1.12 → 2.1.13

package/types/promise-utils.d.ts

@@ -3,13 +3,9 @@
  * 1. timeout=-1, it means no timeout check
  * @param {number} [timeout=-1] - Timeout duration in milliseconds
  * @param {string} [timeoutMessage]
- * @returns {{promise: Promise<*>, reject: function, resolve: function}}
+ * @returns {Deferred}
  */
-export function defer(timeout?: number, timeoutMessage?: string): {
-    promise: Promise<any>;
-    reject: Function;
-    resolve: Function;
-};
+export function defer(timeout?: number, timeoutMessage?: string): Deferred;
 /**
  * Creates a timeout wrapper around a promise that rejects if the promise doesn't resolve within the given time.
  * @param {Promise<*>} promise - The promise to wrap with a timeout
@@ -29,13 +25,13 @@ export function timeout(promise: Promise<any>, time?: number, message?: string):
  * 2. It's NOT convenient to use Promise.allSettled() to get the results of all promises.
  *    * the data structure is not consistent when fullfilled or rejected
  *    * have to check "string" type of status to know sucess or failure
- * @param {Promise} promises
- * @returns {Array<{ok: boolean, result: any}>}
+ * @param {Promise<*>[]} promises
+ * @returns {Promise<{ok: boolean, result: any}[]>}
  */
-export function allSettled(promises: Promise<any>): Array<{
+export function allSettled(promises: Promise<any>[]): Promise<{
     ok: boolean;
     result: any;
-}>;
+}[]>;
 /**
    * Execute the task Function, and ensure it returns a Promise.
    * @param {function} task
@@ -51,7 +47,7 @@ export function returnValuePromised(task: Function): Promise<any>;
    *
    * @param {Promise<*>|number|undefined} [promise] - The input promise to delay
    * @param {number|undefined} [ms] - Minimum delay in milliseconds (default: 1)
-   * @returns {Promise} A new promise that settles after the delay period
+   * @returns {Promise<*>} A new promise that settles after the delay period
    */
 export function delay(promise?: Promise<any> | number | undefined, ms?: number | undefined): Promise<any>;
 /**
@@ -59,10 +55,10 @@ export function delay(promise?: Promise<any> | number | undefined, ms?: number |
    * 1. export function are executed one by one
    * 2. Fast Fail: if any tasks fail, the whole chain is rejected with the first error
    * 3. if an element is not function, rejects the whole chain with Error(Not Function)
-   * @param {Function[]} promises
-   * @returns {Promise<Array>} Promise that resolves with an array of results in the same order as input tasks
+   * @param {Function[]} tasks
+   * @returns {Promise<any[]>} Promise that resolves with an array of results in the same order as input tasks
    */
-export function series(tasks: any): Promise<any[]>;
+export function series(tasks: Function[]): Promise<any[]>;
 /**
    * AllSettled Mode to execute Tasks(functions) in series (one after another) and returns their results in order.
    * 1. tasks are executed one by one
@@ -81,7 +77,7 @@ export function seriesAllSettled(tasks: Function[]): Promise<Array<{
    * 2. rejects whole chain with the first error, when first task fails
    * @param {Function[]} tasks
    * @param {number} [maxParallel=5]
-   * @returns {Promise<Array>} Array of resolved values from all promises
+   * @returns {Promise<any[]>} Array of resolved values from all promises
    * @throws {TypeError} If input is not an array of export function or maxParallel is not a number
    */
 export function parallel(tasks: Function[], maxParallel?: number): Promise<any[]>;
@@ -91,7 +87,7 @@ export function parallel(tasks: Function[], maxParallel?: number): Promise<any[]
    * 2. all tasks will be executed, even some of them failed.
    * @param {Function[]} tasks
    * @param {number} [maxParallel=5] - Maximum number of tasks to run in parallel
-   * @returns {Promise<Array>} Array of resolved values from all promises
+   * @returns {Promise<any[]>} Array of resolved values from all promises
    * @throws {TypeError} If input is not an array of export function or maxParallel is not a number
    */
 export function parallelAllSettled(tasks: Function[], maxParallel?: number): Promise<any[]>;
@@ -107,3 +103,13 @@ declare namespace _default {
     export { parallelAllSettled };
 }
 export default _default;
+export type Deferred = {
+    promise: Promise<any>;
+    timerHandler: NodeJS.Timeout;
+    timerCleared: boolean;
+    resolved: boolean;
+    rejected: boolean;
+    canceled: boolean;
+    reject: (reason: Error) => void;
+    resolve: (...args: any[]) => void;
+};