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

package/README.md

@@ -3,16 +3,19 @@
 These Promise-related utilities boast 100% test coverage, ensuring robust reliability.
 The package, free of external dependencies, offers essential functions such as:
 
-- `repeat`: Executes an operation repeatedly, very useful to collect all results through pagination.
-- `withRetry`: Retries an operation until a specified condition is met.
-- `withConcurrency`: Executes multiple operations with specified level of concurrency, and abort remaining operations when an error happens.
-- `inParallel`: Executes multiple operations with specified level of concurrency, all operations are guaranteed to be executed regardless of any possible error.
+- `repeat`: Executes an operation repeatedly; useful for collecting paged results.
+- `withRetry`: Retries an operation with configurable backoff and retry predicate.
+- `withConcurrency`: Runs jobs in parallel with a concurrency limit and aborts remaining jobs on the first error.
+- `inParallel`: Runs jobs in parallel with a concurrency limit and returns all results and errors (does not abort on any error by default).
 - `delayedResolve`: Creates a Promise that resolves after a specified delay.
 - `delayedReject`: Creates a Promise that rejects after a specified delay.
-- `timeoutResolve`: Applies a timeout to a Promise and resolves with a specified result if the timeout occurs.
-- `timeoutReject`: Applies a timeout to a Promise and rejects with a specified error/reason if the timeout occurs.
-- `promiseState`: Retrieves the state of a Promise.
-- `synchronized`: Provides mutual exclusion for concurrent operations using a lock mechanism, similar to `synchronized` in Java.
+- `cancellableDelayedResolve`: Like `delayedResolve` but returns `{ stop(), promise }` to allow cancelling before the timer fires.
+- `cancellableDelayedReject`: Like `delayedReject` but returns `{ stop(), promise }` to allow cancelling before the timer fires.
+- `timeoutResolve`: Applies a timeout to a Promise and resolves with a fallback value if the timeout occurs.
+- `timeoutReject`: Applies a timeout to a Promise and rejects with a fallback reason if the timeout occurs.
+- `promiseState`: Retrieves the state of a Promise (Pending/Fulfilled/Rejected).
+- `synchronized` / `synchronised`: Provides mutual exclusion (lock) semantics for async operations.
+- `runPeriodically`: Runs an operation periodically with configurable intervals and stopping conditions.
 
 [![Version](https://img.shields.io/npm/v/@handy-common-utils/promise-utils.svg)](https://npmjs.org/package/@handy-common-utils/promise-utils)
 [![Downloads/week](https://img.shields.io/npm/dw/@handy-common-utils/promise-utils.svg)](https://npmjs.org/package/@handy-common-utils/promise-utils)
@@ -27,63 +30,77 @@ First add it as a dependency:
 npm install @handy-common-utils/promise-utils
 ```
 
-Then you can use it in the code:
+Then you can use it in the code. Below are minimal examples; full short snippets are grouped in the "Examples" section further down.
 
 ```javascript
 import { PromiseUtils } from '@handy-common-utils/promise-utils';
 
-// delayedResolve(...), delayedReject(...), promiseState(...)
-const p1 = PromiseUtils.delayedResolve(50, 1);
-const p2 = PromiseUtils.delayedReject(50, 2);
-await expect(PromiseUtils.promiseState(p1)).eventually.eq(PromiseState.Pending);
-await expect(PromiseUtils.promiseState(p2)).eventually.eq(PromiseState.Pending);
-await PromiseUtils.delayedResolve(80);
-await expect(PromiseUtils.promiseState(p1)).eventually.eq(PromiseState.Fulfilled);
-await expect(PromiseUtils.promiseState(p2)).eventually.eq(PromiseState.Rejected);
-
-// timeoutReject(...)
-const p = PromiseUtils.timeoutReject(PromiseUtils.delayedReject(80, '1'), 10, '2');
-await expect(p).to.be.rejectedWith('2');
-
-// repeat(...)
-async repeatFetchingItemsByPosition<T>(
-  fetchItemsByPosition: (parameter: { position?: string }) => Promise<{ position?: string; items?: Array<T> }>,
-) {
-  return PromiseUtils.repeat(
-    fetchItemsByPosition,
-    response => response.position ? { position: response.position } : null,
-    (collection, response) => response.items ? collection.concat(response.items) : collection,
-    [] as Array<T>,
-  );
-}
+// basic usage (short):
+await PromiseUtils.delayedResolve(50, 'ok');
+await PromiseUtils.timeoutReject(PromiseUtils.delayedReject(80, '1'), 10, '2');
+
+// See the Examples section below for more grouped snippets (Timers, Concurrency, Scheduling).
 ```
 
-You can either import and use the [PromiseUtils class](#classespromiseutilsmd) as shown above,
-or you can import its re-exported functions directly like below:
+You can either import and use the [PromiseUtils class](#classespromiseutilsmd) as shown above, or import only the helpers you need. For example:
 
 ```javascript
-import { withRetry, inParallel, FIBONACCI_SEQUENCE, EXPONENTIAL_SEQUENCE } from '@handy-common-utils/promise-utils';
+import { withRetry, delayedResolve, cancellableDelayedReject, withConcurrency, inParallel, runPeriodically } from '@handy-common-utils/promise-utils';
 
-// withRetry(...)
-const result = await withRetry(() => doSomething(), [100, 200, 300, 500, 800, 1000]);
-const result2 = await withRetry(() => doSomething(), Array.from({length: 10}, (_v, i) => 1000 * Math.min(FIBONACCI_SEQUENCE[i], 10)), err => err.statusCode === 429);
-const result3 = await withRetry(() => doSomething(), attempt => attempt <= 8 ? 1000 * Math.min(EXPONENTIAL_SEQUENCE[attempt - 1], 10) : undefined, err => err.statusCode === 429);
-statusCode === 429);
+// Import-focused example — the actual usage is the same as using PromiseUtils.
+const result = await withRetry(() => doSomething(), [100, 200, 300]);
+const p = delayedResolve(100, 'ok');
+const c = cancellableDelayedReject(2000, 'timeout-reason');
+// c.stop() can cancel the scheduled rejection before it fires
+```
 
-// Capture errors in the returned array
-const attributesAndPossibleErrors = await PromiseUtils.inParallel(5, topicArns, async (topicArn) => {
-  const topicAttributes = (await sns.getTopicAttributes({ TopicArn: topicArn }).promise()).Attributes!;
-  return topicAttributes;
-});
+## Quick examples
 
-// Abort on the first error
-let results: Array<JobResult>;
+### Timers
+
+```javascript
+// delayedResolve / delayedReject
+await delayedResolve(50, 'ok');
+
+// cancellableDelayedResolve: returns { stop, promise }
+const { stop, promise } = cancellableDelayedResolve(1000, () => Promise.resolve('ready'));
+// cancel before it fires
+stop();
+```
+
+`delayedReject` and `cancellableDelayedReject` are similar.
+
+### Concurrency & Parallelism
+
+```javascript
+// withConcurrency: abort remaining on first error
 try {
-  results = await PromiseUtils.withConcurrency(100, jobs, async (job) => processor.process(job));
-} catch (error) {
-  // handle the error
+  await withConcurrency(5, jobs, async (job) => process(job));
+} catch (err) {
+  // an error occurred and remaining jobs may not have been started
 }
 
+// inParallel: collect all results and errors
+const results = await inParallel(5, jobs, async (job) => process(job));
+// results contains either values or error objects in the original order
+```
+
+### Scheduling & Utilities
+
+```javascript
+// runPeriodically: schedule repeated work
+const controller = runPeriodically(async (i) => {
+  console.log('iteration', i);
+  await delayedResolve(10);
+}, 100, { maxExecutions: 5 });
+...
+controller.stop(); // stop now
+await controller.done; // wait until it stops
+
+// synchronized: lock a resource
+await PromiseUtils.synchronized('my-lock', async () => {
+  // only one callback for 'my-lock' runs at a time
+});
 ```
 
 # API
@@ -143,11 +160,19 @@ PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 5).map(n
 
 ### Functions
 
-#### delayedReject
+#### cancellableDelayedReject
 
-▸ **delayedReject**\<`T`, `R`\>(`ms`, `reason`): `Promise`\<`T`\>
+▸ **cancellableDelayedReject**\<`T`, `R`\>(`ms`, `reason`): `Object`
+
+Creates a cancellable timer that will reject after a specified number of milliseconds.
 
-See [delayedReject](#delayedreject) for full documentation.
+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.
 
 ##### Type parameters
 
@@ -158,22 +183,114 @@ See [delayedReject](#delayedreject) for full documentation.
 
 ##### Parameters
 
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ms` | `number` | The number of milliseconds after which the scheduled rejection will occur. |
+| `reason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> | The reason for the rejection, or a function that supplies the reason. |
+
+##### Returns
+
+`Object`
+
+An object with stop() and promise.
+
+| Name | Type |
+| :------ | :------ |
+| `promise` | `Promise`\<`T`\> |
+| `stop` | () => `void` |
+
+___
+
+#### cancellableDelayedResolve
+
+▸ **cancellableDelayedResolve**\<`T`\>(`ms`, `result?`): `Object`
+
+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.
+
+##### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ms` | `number` | The number of milliseconds after which the scheduled resolution will occur. |
+| `result?` | `T` \| `PromiseLike`\<`T`\> \| () => `T` \| `PromiseLike`\<`T`\> | The result to be resolved by the Promise, or a function that supplies the result. |
+
+##### Returns
+
+`Object`
+
+An object with stop() and promise.
+
+| Name | Type |
+| :------ | :------ |
+| `promise` | `Promise`\<`T`\> |
+| `stop` | () => `void` |
+
+___
+
+#### delayedReject
+
+▸ **delayedReject**\<`T`, `R`\>(`ms`, `reason`): `Promise`\<`T`\>
+
+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).
+
+##### Type parameters
+
 | Name | Type |
 | :------ | :------ |
-| `ms` | `number` |
-| `reason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> |
+| `T` | `never` |
+| `R` | `any` |
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ms` | `number` | The number of milliseconds after which the created Promise will reject. |
+| `reason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> | The reason for the rejection, or a function that supplies the reason. |
 
 ##### Returns
 
 `Promise`\<`T`\>
 
+A Promise that rejects with the specified reason after the specified delay.
+
 ___
 
 #### delayedResolve
 
 ▸ **delayedResolve**\<`T`\>(`ms`, `result?`): `Promise`\<`T`\>
 
-See [delayedResolve](#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.
 
 ##### Type parameters
 
@@ -183,22 +300,32 @@ See [delayedResolve](#delayedresolve) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `ms` | `number` |
-| `result?` | `T` \| `PromiseLike`\<`T`\> \| () => `T` \| `PromiseLike`\<`T`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ms` | `number` | The number of milliseconds after which the created Promise will resolve. |
+| `result?` | `T` \| `PromiseLike`\<`T`\> \| () => `T` \| `PromiseLike`\<`T`\> | The result to be resolved by the Promise, or a function that supplies the result. |
 
 ##### Returns
 
 `Promise`\<`T`\>
 
+A Promise that resolves with the specified result after the specified delay.
+
 ___
 
 #### inParallel
 
 ▸ **inParallel**\<`Data`, `Result`, `TError`\>(`parallelism`, `jobs`, `operation`, `options?`): `Promise`\<(`Result` \| `TError`)[]\>
 
-See [inParallel](#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.
 
 ##### Type parameters
 
@@ -210,43 +337,51 @@ See [inParallel](#inparallel) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `parallelism` | `number` |
-| `jobs` | `Iterable`\<`Data`\> |
-| `operation` | (`job`: `Data`, `index`: `number`) => `Promise`\<`Result`\> |
-| `options?` | `Object` |
-| `options.abortOnError` | `boolean` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `parallelism` | `number` | The number of jobs/operations to run concurrently. |
+| `jobs` | `Iterable`\<`Data`\> | The job data to be processed. This function can safely handle an infinite or unknown number of elements. |
+| `operation` | (`job`: `Data`, `index`: `number`) => `Promise`\<`Result`\> | The function that processes job data asynchronously. |
+| `options?` | `Object` | Options to control the function's behavior. |
+| `options.abortOnError` | `boolean` | If true, the function aborts and throws an error on the first failed operation. |
 
 ##### Returns
 
 `Promise`\<(`Result` \| `TError`)[]\>
 
+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.
+
 ___
 
 #### promiseState
 
 ▸ **promiseState**(`p`): `Promise`\<[`PromiseState`](#enumspromisestatemd)\>
 
-See [promiseState](#promisestate) for full documentation.
+Retrieves the state of the specified Promise.
+Note: The returned value is a Promise that resolves immediately.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `p` | `Promise`\<`any`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `p` | `Promise`\<`any`\> | The Promise whose state is to be determined. |
 
 ##### Returns
 
 `Promise`\<[`PromiseState`](#enumspromisestatemd)\>
 
+A Promise that resolves immediately with the state of the input Promise.
+
 ___
 
 #### repeat
 
 ▸ **repeat**\<`Result`, `Param`, `Collection`\>(`operation`, `nextParameter`, `collect`, `initialCollection`, `initialParameter?`): `Promise`\<`Collection`\>
 
-See [repeat](#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.
 
 ##### Type parameters
 
@@ -258,25 +393,27 @@ See [repeat](#repeat) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `operation` | (`parameter`: `Partial`\<`Param`\>) => `Promise`\<`Result`\> |
-| `nextParameter` | (`response`: `Result`) => ``null`` \| `Partial`\<`Param`\> \| `Promise`\<`Partial`\<`Param`\>\> |
-| `collect` | (`collection`: `Collection`, `result`: `Result`) => `Collection` |
-| `initialCollection` | `Collection` |
-| `initialParameter` | `Partial`\<`Param`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `operation` | (`parameter`: `Partial`\<`Param`\>) => `Promise`\<`Result`\> | A function that takes a parameter as input and returns a result. Typically, the parameter has optional fields to control paging. |
+| `nextParameter` | (`response`: `Result`) => ``null`` \| `Partial`\<`Param`\> \| `Promise`\<`Partial`\<`Param`\>\> | 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. |
+| `collect` | (`collection`: `Collection`, `result`: `Result`) => `Collection` | A function for merging the operation result into the collection. |
+| `initialCollection` | `Collection` | The initial collection, which will be the first argument passed to the first invocation of the collect function. |
+| `initialParameter` | `Partial`\<`Param`\> | The parameter for the first operation. |
 
 ##### Returns
 
 `Promise`\<`Collection`\>
 
+A promise that resolves to a collection of all the results returned by the operation function.
+
 ___
 
-#### synchronised
+#### runPeriodically
 
-▸ **synchronised**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+▸ **runPeriodically**\<`T`\>(`operation`, `interval`, `options?`): `Object`
 
-See [synchronised](#synchronised) for full documentation.
+Runs an operation periodically with configurable intervals and stopping conditions.
 
 ##### Type parameters
 
@@ -286,22 +423,65 @@ See [synchronised](#synchronised) for full documentation.
 
 ##### Parameters
 
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `operation` | (`iteration`: `number`) => `T` \| `Promise`\<`T`\> | The operation to run periodically. |
+| `interval` | `number` \| `number`[] \| (`iteration`: `number`) => `undefined` \| `number` | The interval (ms), array of intervals, or function returning interval per iteration. |
+| `options?` | `Object` | Options for maxExecutions, maxDurationMs, and schedule type. |
+| `options.maxDurationMs?` | `number` | - |
+| `options.maxExecutions?` | `number` | - |
+| `options.schedule?` | ``"delayAfterEnd"`` \| ``"delayBetweenStarts"`` | - |
+
+##### Returns
+
+`Object`
+
+An object with stop() and done Promise which resolves when the periodic runner stops (or rejects if the operation errors).
+
 | Name | Type |
 | :------ | :------ |
-| `lock` | `any` |
-| `operation` | (`previousState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousSettledState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousResult`: `any`) => `Promise`\<`T`\> |
+| `done` | `Promise`\<`void`\> |
+| `stop` | () => `void` |
+
+___
+
+#### synchronised
+
+▸ **synchronised**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+
+This is just another spelling of synchronized.
+
+##### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `lock` | `any` | The object (such as a string, a number, or this in a class) used to identify the lock. |
+| `operation` | (`previousState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousSettledState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousResult`: `any`) => `Promise`\<`T`\> | The function that performs the computation and returns a Promise. |
 
 ##### Returns
 
 `Promise`\<`T`\>
 
+The result of the operation function.
+
 ___
 
 #### synchronized
 
 ▸ **synchronized**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
 
-See [synchronized](#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.
 
 ##### Type parameters
 
@@ -311,22 +491,28 @@ See [synchronized](#synchronized) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `lock` | `any` |
-| `operation` | (`previousState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousSettledState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousResult`: `any`) => `Promise`\<`T`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `lock` | `any` | The object (such as a string, a number, or this in a class) used to identify the lock. |
+| `operation` | (`previousState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousSettledState`: `undefined` \| [`PromiseState`](#enumspromisestatemd), `previousResult`: `any`) => `Promise`\<`T`\> | The function that performs the computation and returns a Promise. |
 
 ##### Returns
 
 `Promise`\<`T`\>
 
+The result of the operation function.
+
 ___
 
 #### timeoutReject
 
 ▸ **timeoutReject**\<`T`, `R`\>(`operation`, `ms`, `rejectReason`): `Promise`\<`T`\>
 
-See [timeoutReject](#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."
 
 ##### Type parameters
 
@@ -337,23 +523,30 @@ See [timeoutReject](#timeoutreject) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `operation` | `Promise`\<`T`\> \| () => `Promise`\<`T`\> |
-| `ms` | `number` |
-| `rejectReason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `operation` | `Promise`\<`T`\> \| () => `Promise`\<`T`\> | The original Promise or a function that returns a Promise to which the timeout will be applied. |
+| `ms` | `number` | The number of milliseconds for the timeout. |
+| `rejectReason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> | The reason to reject with if the timeout occurs, or a function that supplies the reason. |
 
 ##### Returns
 
 `Promise`\<`T`\>
 
+A new Promise that rejects with the specified reason if the timeout occurs.
+
 ___
 
 #### timeoutResolve
 
 ▸ **timeoutResolve**\<`T`\>(`operation`, `ms`, `result?`): `Promise`\<`T`\>
 
-See [timeoutResolve](#timeoutresolve) for full documentation.
+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."
 
 ##### Type parameters
 
@@ -363,23 +556,25 @@ See [timeoutResolve](#timeoutresolve) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `operation` | `Promise`\<`T`\> \| () => `Promise`\<`T`\> |
-| `ms` | `number` |
-| `result?` | `T` \| `PromiseLike`\<`T`\> \| () => `T` \| `PromiseLike`\<`T`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `operation` | `Promise`\<`T`\> \| () => `Promise`\<`T`\> | The original Promise or a function that returns a Promise to which the timeout will be applied. |
+| `ms` | `number` | The number of milliseconds for the timeout. |
+| `result?` | `T` \| `PromiseLike`\<`T`\> \| () => `T` \| `PromiseLike`\<`T`\> | The result to resolve with if the timeout occurs, or a function that supplies the result. |
 
 ##### Returns
 
 `Promise`\<`T`\>
 
+A new Promise that resolves to the specified result if the timeout occurs.
+
 ___
 
 #### withConcurrency
 
 ▸ **withConcurrency**\<`Data`, `Result`\>(`concurrency`, `jobs`, `operation`): `Promise`\<`Result`[]\>
 
-See [withConcurrency](#withconcurrency) for full documentation.
+Executes multiple jobs/operations with a specified level of concurrency.
 
 ##### Type parameters
 
@@ -390,23 +585,26 @@ See [withConcurrency](#withconcurrency) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `concurrency` | `number` |
-| `jobs` | `Iterable`\<`Data`\> |
-| `operation` | (`job`: `Data`, `index`: `number`) => `Promise`\<`Result`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `concurrency` | `number` | The number of jobs/operations to run concurrently. |
+| `jobs` | `Iterable`\<`Data`\> | The job data to be processed. This function can handle an infinite or unknown number of elements safely. |
+| `operation` | (`job`: `Data`, `index`: `number`) => `Promise`\<`Result`\> | The function that processes job data asynchronously. |
 
 ##### Returns
 
 `Promise`\<`Result`[]\>
 
+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.
+
 ___
 
 #### withRetry
 
 ▸ **withRetry**\<`Result`, `TError`\>(`operation`, `backoff`, `shouldRetry?`): `Promise`\<`Result`\>
 
-See [withRetry](#withretry) for full documentation.
+Repeatedly performs an operation until a specified criteria is met.
 
 ##### Type parameters
 
@@ -417,16 +615,18 @@ See [withRetry](#withretry) for full documentation.
 
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `operation` | (`attempt`: `number`, `previousResult`: `undefined` \| `Result`, `previousError`: `undefined` \| `TError`) => `Promise`\<`Result`\> |
-| `backoff` | `number`[] \| (`attempt`: `number`, `previousResult`: `undefined` \| `Result`, `previousError`: `undefined` \| `TError`) => `undefined` \| `number` |
-| `shouldRetry` | (`previousError`: `undefined` \| `TError`, `previousResult`: `undefined` \| `Result`, `attempt`: `number`) => `boolean` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `operation` | (`attempt`: `number`, `previousResult`: `undefined` \| `Result`, `previousError`: `undefined` \| `TError`) => `Promise`\<`Result`\> | A function that outputs a Promise result. Typically, the operation does not use its arguments. |
+| `backoff` | `number`[] \| (`attempt`: `number`, `previousResult`: `undefined` \| `Result`, `previousError`: `undefined` \| `TError`) => `undefined` \| `number` | An array of retry backoff periods (in milliseconds) or a function for calculating them. |
+| `shouldRetry` | (`previousError`: `undefined` \| `TError`, `previousResult`: `undefined` \| `Result`, `attempt`: `number`) => `boolean` | A predicate function for deciding whether another call to the operation should occur. |
 
 ##### Returns
 
 `Promise`\<`Result`\>
 
+A promise of the operation result, potentially with retries applied.
+
 ## Classes
 
 
@@ -442,12 +642,103 @@ See [withRetry](#withretry) for full documentation.
 
 #### Methods
 
+##### cancellableDelayedReject
+
+▸ `Static` **cancellableDelayedReject**\<`T`, `R`\>(`ms`, `reason`): `Object`
+
+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.
+
+###### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `never` |
+| `R` | `any` |
+
+###### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ms` | `number` | The number of milliseconds after which the scheduled rejection will occur. |
+| `reason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> | The reason for the rejection, or a function that supplies the reason. |
+
+###### Returns
+
+`Object`
+
+An object with `stop()` and `promise`.
+
+| Name | Type |
+| :------ | :------ |
+| `promise` | `Promise`\<`T`\> |
+| `stop` | () => `void` |
+
+___
+
+##### cancellableDelayedResolve
+
+▸ `Static` **cancellableDelayedResolve**\<`T`\>(`ms`, `result?`): `Object`
+
+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).
+
+###### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+###### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `ms` | `number` | The number of milliseconds after which the scheduled resolution will occur. |
+| `result?` | `T` \| `PromiseLike`\<`T`\> \| () => `T` \| `PromiseLike`\<`T`\> | The result to be resolved by the Promise, or a function that supplies the result. |
+
+###### Returns
+
+`Object`
+
+An object with `stop()` and `promise`.
+
+| Name | Type |
+| :------ | :------ |
+| `promise` | `Promise`\<`T`\> |
+| `stop` | () => `void` |
+
+___
+
 ##### delayedReject
 
 ▸ `Static` **delayedReject**\<`T`, `R`\>(`ms`, `reason`): `Promise`\<`T`\>
 
 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).
+
 ###### Type parameters
 
 | Name | Type |
@@ -460,13 +751,13 @@ Creates a Promise that rejects after a specified number of milliseconds.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `ms` | `number` | The number of milliseconds after which the created Promise will reject. |
-| `reason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> | 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. |
+| `reason` | `R` \| `PromiseLike`\<`R`\> \| () => `R` \| `PromiseLike`\<`R`\> | The reason for the rejection, or a function that supplies the reason. |
 
 ###### Returns
 
 `Promise`\<`T`\>
 
-A new Promise that rejects with the specified reason after the specified delay.
+A Promise that rejects with the specified reason after the specified delay.
 
 ___
 
@@ -476,6 +767,14 @@ ___
 
 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.
+
 ###### Type parameters
 
 | Name |
@@ -493,7 +792,7 @@ Creates a Promise that resolves after a specified number of milliseconds.
 
 `Promise`\<`T`\>
 
-A new Promise that resolves with the specified result after the specified delay.
+A Promise that resolves with the specified result after the specified delay.
 
 ___
 
@@ -622,6 +921,67 @@ const domainNameObjects = await PromiseUtils.repeat(
 
 ___
 
+##### runPeriodically
+
+▸ `Static` **runPeriodically**\<`T`\>(`operation`, `interval`, `options?`): `Object`
+
+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`.
+
+###### Type parameters
+
+| Name | Description |
+| :------ | :------ |
+| `T` | The operation return type (ignored by the runner; used for typing). |
+
+###### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `operation` | (`iteration`: `number`) => `T` \| `Promise`\<`T`\> | Function to run each iteration. Receives the iteration index (1-based). |
+| `interval` | `number` \| `number`[] \| (`iteration`: `number`) => `undefined` \| `number` | Number \| number[] \| ((iteration: number) => number\|undefined) defining waits. |
+| `options?` | `Object` | Optional configuration. |
+| `options.maxDurationMs?` | `number` | - |
+| `options.maxExecutions?` | `number` | - |
+| `options.schedule?` | ``"delayAfterEnd"`` \| ``"delayBetweenStarts"`` | - |
+
+###### Returns
+
+`Object`
+
+An object containing `stop()` to cancel further executions and `done` Promise
+         which resolves when the periodic runner stops (or rejects if the operation errors).
+
+| Name | Type |
+| :------ | :------ |
+| `done` | `Promise`\<`void`\> |
+| `stop` | () => `void` |
+
+___
+
 ##### synchronised
 
 ▸ `Static` **synchronised**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>