@handy-common-utils/promise-utils 1.6.0 → 1.7.0

package/dist/promise-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promiseState = exports.synchronised = exports.synchronized = exports.timeoutReject = exports.timeoutResolve = exports.delayedReject = exports.delayedResolve = exports.inParallel = exports.withConcurrency = exports.withRetry = exports.repeat = exports.PromiseUtils = exports.PromiseState = exports.EXPONENTIAL_SEQUENCE = exports.FIBONACCI_SEQUENCE = void 0;
+exports.runPeriodically = exports.promiseState = exports.synchronised = exports.synchronized = exports.timeoutReject = exports.timeoutResolve = exports.cancellableDelayedReject = exports.cancellableDelayedResolve = exports.delayedReject = exports.delayedResolve = exports.inParallel = exports.withConcurrency = exports.withRetry = exports.repeat = exports.PromiseUtils = exports.PromiseState = exports.EXPONENTIAL_SEQUENCE = exports.FIBONACCI_SEQUENCE = void 0;
 /**
  * Array of 25 Fibonacci numbers starting from 1 up to 317811.
  * It can be used to form your own backoff interval array.
@@ -205,31 +205,120 @@ class PromiseUtils {
         await Promise.all(promises);
         return jobResults;
     }
+    /**
+     * Creates a cancellable timer that will resolve after a specified number of milliseconds.
+     *
+     * The returned object contains:
+     * - `stop()` to cancel the scheduled resolution (if called before the timer fires). Calling
+     *   `stop()` prevents the promise from being settled by this timer.
+     * - `promise` which will resolve with the supplied `result` (or the value returned by the
+     *   `result` function) after `ms` milliseconds unless `stop()` is called first.
+     *
+     * Note: If the `result` is a function that returns a Promise, the returned `promise` will
+     * resolve with that Promise's resolution (i.e. it behaves like resolving with a PromiseLike).
+     *
+     * @param ms The number of milliseconds after which the scheduled resolution will occur.
+     * @param result The result to be resolved by the Promise, or a function that supplies the result.
+     * @returns An object with `stop()` and `promise`.
+     */
+    static cancellableDelayedResolve(ms, result) {
+        let stopped = false;
+        let timer;
+        const promise = new Promise(resolve => {
+            timer = setTimeout(() => {
+                timer = undefined;
+                if (stopped)
+                    return;
+                resolve(typeof result === 'function' ? result() : result);
+            }, ms);
+        });
+        const stop = () => {
+            if (stopped)
+                return;
+            stopped = true;
+            if (timer !== undefined) {
+                clearTimeout(timer);
+                timer = undefined;
+            }
+        };
+        return { stop, promise };
+    }
     /**
      * Creates a Promise that resolves after a specified number of milliseconds.
      *
+     * The `result` argument may be:
+     * - a value to resolve with,
+     * - a PromiseLike whose resolution will be adopted by the returned Promise, or
+     * - a function which is invoked when the timer fires and may return a value or a PromiseLike.
+     *
+     * If `result` is a function, it is called when the timer elapses; if it returns a Promise,
+     * the returned Promise will adopt that Promise's outcome.
+     *
      * @param ms The number of milliseconds after which the created Promise will resolve.
      * @param result The result to be resolved by the Promise, or a function that supplies the result.
-     * @returns A new Promise that resolves with the specified result after the specified delay.
+     * @returns A Promise that resolves with the specified result after the specified delay.
      */
     static delayedResolve(ms, result) {
-        // eslint-disable-next-line no-promise-executor-return
-        return new Promise(resolve => setTimeout(() => resolve(typeof result === 'function' ? result() : result), ms));
+        return PromiseUtils.cancellableDelayedResolve(ms, result).promise;
+    }
+    /**
+     * Creates a cancellable timer that will reject after a specified number of milliseconds.
+     *
+     * The returned object contains:
+     * - `stop()` to cancel the scheduled rejection (if called before the timer fires). Calling
+     *   `stop()` prevents the promise from being settled by this timer.
+     * - `promise` which will reject with the supplied `reason` (or the value returned by the
+     *   `reason` function) after `ms` milliseconds unless `stop()` is called first.
+     *
+     * If the `reason` is a PromiseLike that rejects, its rejection value will be used as the rejection reason.
+     *
+     * @param ms The number of milliseconds after which the scheduled rejection will occur.
+     * @param reason The reason for the rejection, or a function that supplies the reason.
+     * @returns An object with `stop()` and `promise`.
+     */
+    static cancellableDelayedReject(ms, reason) {
+        let stopped = false;
+        let timer;
+        const promise = new Promise((_resolve, reject) => {
+            timer = setTimeout(() => {
+                timer = undefined;
+                if (stopped)
+                    return;
+                const r = typeof reason === 'function' ? reason() : reason;
+                // Resolve the possibly-PromiseLike `r` and reject the outer promise with either
+                // the resolved value or the rejection reason of `r`.
+                Promise.resolve(r).then(reject, reject);
+            }, ms);
+        });
+        const stop = () => {
+            if (stopped)
+                return;
+            stopped = true;
+            if (timer !== undefined) {
+                clearTimeout(timer);
+                timer = undefined;
+            }
+        };
+        return { stop, promise };
     }
     /**
      * Creates a Promise that rejects after a specified number of milliseconds.
      *
+     * The `reason` argument may be:
+     * - a value to reject with,
+     * - a PromiseLike whose rejection will be adopted by the returned Promise, or
+     * - a function which is invoked when the timer fires and may return a value or a PromiseLike.
+     *
+     * If `reason` is a function, it is called when the timer elapses; if it returns a Promise,
+     * the returned Promise will reject with that Promise's rejection reason (or reject with the
+     * returned value if it resolves).
+     *
      * @param ms The number of milliseconds after which the created Promise will reject.
      * @param reason The reason for the rejection, or a function that supplies the reason.
-     *               If the reason is a rejected Promise, the outcome of it will be the rejection reason of the returned Promise.
-     * @returns A new Promise that rejects with the specified reason after the specified delay.
+     * @returns A Promise that rejects with the specified reason after the specified delay.
      */
     static delayedReject(ms, reason) {
-        // eslint-disable-next-line no-promise-executor-return
-        return new Promise((_resolve, reject) => setTimeout(() => {
-            const r = typeof reason === 'function' ? reason() : reason;
-            Promise.resolve(r).catch(error => error).then(r => reject(r));
-        }, ms));
+        return PromiseUtils.cancellableDelayedReject(ms, reason).promise;
     }
     /**
      * Applies a timeout to a Promise or a function that returns a Promise.
@@ -334,50 +423,282 @@ class PromiseUtils {
     static async synchronised(lock, operation) {
         return PromiseUtils.synchronized(lock, operation);
     }
+    /**
+     * Runs an operation periodically with configurable intervals and stopping conditions.
+     *
+     * - `interval` may be a single number (ms), an array of numbers, or a function
+     *   that receives the iteration number (starting at 1) and returns the next
+     *   interval in milliseconds or `undefined` to stop.
+     * - If the interval array runs out of elements or the function returns `undefined`
+     *   (or a negative value), no further invocations will be scheduled.
+     *
+     * Options:
+     * - `maxExecutions` stop after N runs (inclusive).
+     * - `maxDurationMs` stop after elapsed ms since the first scheduled start.
+     * - `schedule` controls how the interval is measured:
+    *   - `'delayAfterEnd'`: wait the interval after the previous operation completes
+     *     before scheduling the next one (equivalent to a fixed delay between ends).
+     *   - `'delayBetweenStarts'`: keep start times on a regular schedule (interval measured
+     *     between the starts of successive operations).
+    *   The default schedule is `'delayBetweenStarts'`.
+     *
+    * Returns an object with `stop()` to cancel further executions and `done` which
+    * resolves when the periodic runner stops. If the provided `operation` throws or
+    * rejects, the `done` promise will reject with that error so callers can handle it.
+    *
+    * Note: The first invocation of `operation` is scheduled after the first interval
+    * elapses (i.e. this function does NOT call `operation` immediately). If you need
+    * an immediate run, invoke `operation(1)` yourself before calling `runPeriodically`.
+     *
+     * @template T The operation return type (ignored by the runner; used for typing).
+     * @param operation Function to run each iteration. Receives the iteration index (1-based).
+     * @param interval Number | number[] | ((iteration: number) => number|undefined) defining waits.
+     * @param options Optional configuration.
+     * @returns An object containing `stop()` to cancel further executions and `done` Promise
+     *          which resolves when the periodic runner stops (or rejects if the operation errors).
+     */
+    static runPeriodically(operation, interval, options) {
+        let stopped = false;
+        let timer;
+        let waitResolve;
+        const stop = () => {
+            stopped = true;
+            if (timer !== undefined) {
+                clearTimeout(timer);
+                timer = undefined;
+            }
+            if (waitResolve) {
+                // resolve the pending wait so the runner can notice `stopped` and exit
+                const r = waitResolve;
+                waitResolve = undefined;
+                r();
+            }
+        };
+        const getInterval = (iteration) => {
+            if (Array.isArray(interval)) {
+                return interval[iteration - 1];
+            }
+            if (typeof interval === 'function') {
+                return interval(iteration);
+            }
+            return interval;
+        };
+        const done = (async () => {
+            var _a;
+            const startTime = Date.now();
+            let iteration = 0;
+            // lastStart tracks the start time of the previous iteration (used by delayBetweenStarts)
+            let lastStart = Date.now();
+            while (!stopped) {
+                const nextIteration = iteration + 1;
+                const nextInterval = getInterval(nextIteration);
+                if (nextInterval == null || nextInterval < 0)
+                    break;
+                const schedule = (_a = options === null || options === void 0 ? void 0 : options.schedule) !== null && _a !== void 0 ? _a : 'delayBetweenStarts';
+                const waitMs = schedule === 'delayBetweenStarts'
+                    ? Math.max(0, lastStart + nextInterval - Date.now())
+                    : nextInterval;
+                // wait (cancelable via stop() which clears the timeout and resolves the wait)
+                await new Promise(resolve => {
+                    waitResolve = resolve;
+                    timer = setTimeout(() => { timer = undefined; waitResolve = undefined; resolve(); }, waitMs);
+                });
+                waitResolve = undefined;
+                if (stopped)
+                    break;
+                iteration = nextIteration;
+                lastStart = Date.now();
+                // let errors propagate to the done promise so caller can decide handling
+                await operation(iteration);
+                if ((options === null || options === void 0 ? void 0 : options.maxExecutions) && iteration >= options.maxExecutions)
+                    break;
+                if ((options === null || options === void 0 ? void 0 : options.maxDurationMs) && (Date.now() - startTime) >= options.maxDurationMs)
+                    break;
+            }
+        })();
+        return { stop, done };
+    }
 }
 exports.PromiseUtils = PromiseUtils;
 PromiseUtils.synchronizationLocks = new Map();
 /**
- * See {@link PromiseUtils.repeat} for full documentation.
+ * Executes an operation repeatedly and collects all the results.
+ * This function is very useful for many scenarios, such like client-side pagination.
+ *
+ * @param operation A function that takes a parameter as input and returns a result. Typically, the parameter has optional fields to control paging.
+ * @param nextParameter A function for calculating the next parameter from the operation result. Normally, this parameter controls paging. This function should return null when no further invocation of the operation function is desired. If further invocation is desired, the return value of this function can be a Promise or a non-Promise value.
+ * @param collect A function for merging the operation result into the collection.
+ * @param initialCollection The initial collection, which will be the first argument passed to the first invocation of the collect function.
+ * @param initialParameter The parameter for the first operation.
+ * @returns A promise that resolves to a collection of all the results returned by the operation function.
  */
 exports.repeat = PromiseUtils.repeat;
 /**
- * See {@link PromiseUtils.withRetry} for full documentation.
+ * Repeatedly performs an operation until a specified criteria is met.
+ *
+ * @param operation A function that outputs a Promise result. Typically, the operation does not use its arguments.
+ * @param backoff An array of retry backoff periods (in milliseconds) or a function for calculating them.
+ * @param shouldRetry A predicate function for deciding whether another call to the operation should occur.
+ * @returns A promise of the operation result, potentially with retries applied.
  */
 exports.withRetry = PromiseUtils.withRetry;
 /**
- * See {@link PromiseUtils.withConcurrency} for full documentation.
+ * Executes multiple jobs/operations with a specified level of concurrency.
+ *
+ * @param concurrency The number of jobs/operations to run concurrently.
+ * @param jobs The job data to be processed. This function can handle an infinite or unknown number of elements safely.
+ * @param operation The function that processes job data asynchronously.
+ * @returns A promise that resolves to an array containing the results from the operation function.
+ *          The results in the returned array are in the same order as the corresponding elements in the jobs array.
  */
 exports.withConcurrency = PromiseUtils.withConcurrency;
 /**
- * See {@link PromiseUtils.inParallel} for full documentation.
+ * Executes multiple jobs/operations in parallel. By default, all operations are executed regardless of any failures.
+ * In most cases, using withConcurrency might be more convenient.
+ *
+ * By default, this function does not throw or reject an error when any job/operation fails.
+ * Errors from operations are returned alongside results in the returned array.
+ * This function only resolves when all jobs/operations are settled (either resolved or rejected).
+ *
+ * If options.abortOnError is set to true, this function throws (or rejects with) an error immediately when any job/operation fails.
+ * In this mode, some jobs/operations may not be executed if one fails.
+ *
+ * @param parallelism The number of jobs/operations to run concurrently.
+ * @param jobs The job data to be processed. This function can safely handle an infinite or unknown number of elements.
+ * @param operation The function that processes job data asynchronously.
+ * @param options Options to control the function's behavior.
+ * @param options.abortOnError If true, the function aborts and throws an error on the first failed operation.
+ * @returns A promise that resolves to an array containing the results of the operations.
+ *  Each element is either a fulfilled result or a rejected error/reason.
+ *  The results or errors in the returned array are in the same order as the corresponding elements in the jobs array.
  */
 exports.inParallel = PromiseUtils.inParallel;
 /**
- * See {@link PromiseUtils.delayedResolve} for full documentation.
+ * Creates a Promise that resolves after a specified number of milliseconds.
+ *
+ * The result argument may be:
+ * - a value to resolve with,
+ * - a PromiseLike whose resolution will be adopted by the returned Promise, or
+ * - a function which is invoked when the timer fires and may return a value or a PromiseLike.
+ *
+ * If result is a function, it is called when the timer elapses; if it returns a Promise,
+ * the returned Promise will adopt that Promise's outcome.
+ *
+ * @param ms The number of milliseconds after which the created Promise will resolve.
+ * @param result The result to be resolved by the Promise, or a function that supplies the result.
+ * @returns A Promise that resolves with the specified result after the specified delay.
  */
 exports.delayedResolve = PromiseUtils.delayedResolve;
 /**
- * See {@link PromiseUtils.delayedReject} for full documentation.
+ * Creates a Promise that rejects after a specified number of milliseconds.
+ *
+ * The reason argument may be:
+ * - a value to reject with,
+ * - a PromiseLike whose rejection will be adopted by the returned Promise, or
+ * - a function which is invoked when the timer fires and may return a value or a PromiseLike.
+ *
+ * If reason is a function, it is called when the timer elapses; if it returns a Promise,
+ * the returned Promise will reject with that Promise's rejection reason (or reject with the
+ * returned value if it resolves).
+ *
+ * @param ms The number of milliseconds after which the created Promise will reject.
+ * @param reason The reason for the rejection, or a function that supplies the reason.
+ * @returns A Promise that rejects with the specified reason after the specified delay.
  */
 exports.delayedReject = PromiseUtils.delayedReject;
 /**
- * See {@link PromiseUtils.timeoutResolve} for full documentation.
+ * Creates a cancellable timer that will resolve after a specified number of milliseconds.
+ *
+ * The returned object contains:
+ * - stop() to cancel the scheduled resolution (if called before the timer fires). Calling
+ *   stop() prevents the promise from being settled by this timer.
+ * - promise which will resolve with the supplied result (or the value returned by the
+ *   result function) after ms milliseconds unless stop() is called first.
+ *
+ * If the result is a PromiseLike, its resolution value will be used as the resolved value.
+ *
+ * @param ms The number of milliseconds after which the scheduled resolution will occur.
+ * @param result The result to be resolved by the Promise, or a function that supplies the result.
+ * @returns An object with stop() and promise.
+ */
+exports.cancellableDelayedResolve = PromiseUtils.cancellableDelayedResolve;
+/**
+ * Creates a cancellable timer that will reject after a specified number of milliseconds.
+ *
+ * The returned object contains:
+ * - stop() to cancel the scheduled rejection (if called before the timer fires). Calling
+ *   stop() prevents the promise from being settled by this timer.
+ * - promise which will reject with the supplied reason (or the value returned by the
+ *   reason function) after ms milliseconds unless stop() is called first.
+ *
+ * If the reason is a PromiseLike that rejects, its rejection value will be used as the rejection reason.
+ *
+ * @param ms The number of milliseconds after which the scheduled rejection will occur.
+ * @param reason The reason for the rejection, or a function that supplies the reason.
+ * @returns An object with stop() and promise.
+ */
+exports.cancellableDelayedReject = PromiseUtils.cancellableDelayedReject;
+/**
+ * Applies a timeout to a Promise or a function that returns a Promise.
+ * If the timeout occurs, the returned Promise resolves to the specified result.
+ * If the timeout does not occur, the returned Promise resolves or rejects based on the outcome of the original Promise.
+ * If the result parameter is a function and the timeout does not occur, the function will not be called.
+ * Note: The rejection of the operation parameter is not handled by this function.
+ * You may want to handle it outside this function to avoid warnings like "(node:4330) PromiseRejectionHandledWarning: Promise rejection was handled asynchronously."
+ *
+ * @param operation The original Promise or a function that returns a Promise to which the timeout will be applied.
+ * @param ms The number of milliseconds for the timeout.
+ * @param result The result to resolve with if the timeout occurs, or a function that supplies the result.
+ * @returns A new Promise that resolves to the specified result if the timeout occurs.
  */
 exports.timeoutResolve = PromiseUtils.timeoutResolve;
 /**
- * See {@link PromiseUtils.timeoutReject} for full documentation.
+ * Applies a timeout to a Promise or a function that returns a Promise.
+ * If the timeout occurs, the returned Promise rejects with the specified reason.
+ * If the timeout does not occur, the returned Promise resolves or rejects based on the outcome of the original Promise.
+ * If the rejectReason parameter is a function and the timeout does not occur, the function will not be called.
+ * Note: The rejection of the operation parameter is not handled by this function. You may want to handle it outside this function to avoid warnings like "(node:4330) PromiseRejectionHandledWarning: Promise rejection was handled asynchronously."
+ *
+ * @param operation The original Promise or a function that returns a Promise to which the timeout will be applied.
+ * @param ms The number of milliseconds for the timeout.
+ * @param rejectReason The reason to reject with if the timeout occurs, or a function that supplies the reason.
+ * @returns A new Promise that rejects with the specified reason if the timeout occurs.
  */
 exports.timeoutReject = PromiseUtils.timeoutReject;
 /**
- * See {@link PromiseUtils.synchronized} for full documentation.
+ * Provides mutual exclusion similar to synchronized in Java.
+ * Ensures no concurrent execution of any operation function associated with the same lock.
+ * The operation function has access to the state (when synchronized is called),
+ * settledState (when the operation function is called),
+ * and result (either the fulfilled result or the rejected reason) of the previous operation.
+ * If there is no previous invocation, state, settledState, and result will all be undefined.
+ *
+ * @param lock The object (such as a string, a number, or this in a class) used to identify the lock.
+ * @param operation The function that performs the computation and returns a Promise.
+ * @returns The result of the operation function.
  */
 exports.synchronized = PromiseUtils.synchronized;
 /**
- * See {@link PromiseUtils.synchronised} for full documentation.
+ * This is just another spelling of synchronized.
+ * @param lock The object (such as a string, a number, or this in a class) used to identify the lock.
+ * @param operation The function that performs the computation and returns a Promise.
+ * @returns The result of the operation function.
  */
 exports.synchronised = PromiseUtils.synchronised;
 /**
- * See {@link PromiseUtils.promiseState} for full documentation.
+ * Retrieves the state of the specified Promise.
+ * Note: The returned value is a Promise that resolves immediately.
+ *
+ * @param p The Promise whose state is to be determined.
+ * @returns A Promise that resolves immediately with the state of the input Promise.
  */
 exports.promiseState = PromiseUtils.promiseState;
+/**
+ * Runs an operation periodically with configurable intervals and stopping conditions.
+ *
+ * @param operation The operation to run periodically.
+ * @param interval The interval (ms), array of intervals, or function returning interval per iteration.
+ * @param options Options for maxExecutions, maxDurationMs, and schedule type.
+ * @returns An object with stop() and done Promise which resolves when the periodic runner stops (or rejects if the operation errors).
+ */
+exports.runPeriodically = PromiseUtils.runPeriodically;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@handy-common-utils/promise-utils",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Promise related utilities",
   "scripts": {
     "pretest": "eslint . --ext .ts",