npm - @handy-common-utils/promise-utils - Versions diffs - 1.7.0 → 1.7.1 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md +926 -435
package/dist/promise-utils.d.ts +54 -21
package/dist/promise-utils.d.ts.map +1 -1
package/dist/promise-utils.js +56 -24
package/dist/promise-utils.js.map +1 -0
package/package.json +2 -2

package/README.md CHANGED Viewed

@@ -110,242 +110,258 @@ await PromiseUtils.synchronized('my-lock', async () => {
 ## @handy-common-utils/promise-utils
-### Enumerations
+### Classes
-- [PromiseState](#enumspromisestatemd)
+| Class | Description |
+| ------ | ------ |
+| [PromiseUtils](#classespromiseutilsmd) | - |
-### Classes
+### Type Aliases
-- [PromiseUtils](#classespromiseutilsmd)
+| Type Alias | Description |
+| ------ | ------ |
+| [PromiseStateType](#type-aliasespromisestatetypemd) | - |
 ### Variables
-#### EXPONENTIAL\_SEQUENCE
+| Variable | Description |
+| ------ | ------ |
+| [cancellableDelayedReject](#variablescancellabledelayedrejectmd) | Creates a cancellable timer that will reject after a specified number of milliseconds. |
+| [cancellableDelayedResolve](#variablescancellabledelayedresolvemd) | Creates a cancellable timer that will resolve after a specified number of milliseconds. |
+| [delayedReject](#variablesdelayedrejectmd) | Creates a Promise that rejects after a specified number of milliseconds. |
+| [delayedResolve](#variablesdelayedresolvemd) | Creates a Promise that resolves after a specified number of milliseconds. |
+| [EXPONENTIAL\_SEQUENCE](#variablesexponential_sequencemd) | Array of 25 exponential numbers starting from 1 up to 33554432. It can be used to form your own backoff interval array. |
+| [FIBONACCI\_SEQUENCE](#variablesfibonacci_sequencemd) | Array of 25 Fibonacci numbers starting from 1 up to 317811. It can be used to form your own backoff interval array. |
+| [inParallel](#variablesinparallelmd) | 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. |
+| [promiseState](#variablespromisestatemd) | Retrieves the state of the specified Promise. Note: The returned value is a Promise that resolves immediately. |
+| [PromiseState](#variablespromisestate-1md) | The state of a Promise can only be one of: Pending, Fulfilled, and Rejected. |
+| [repeat](#variablesrepeatmd) | Executes an operation repeatedly and collects all the results. This function is very useful for many scenarios, such like client-side pagination. |
+| [runPeriodically](#variablesrunperiodicallymd) | Runs an operation periodically with configurable intervals and stopping conditions. |
+| [synchronised](#variablessynchronisedmd) | This is just another spelling of synchronized. |
+| [synchronized](#variablessynchronizedmd) | 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. |
+| [timeoutReject](#variablestimeoutrejectmd) | 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." |
+| [timeoutResolve](#variablestimeoutresolvemd) | 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." |
+| [withConcurrency](#variableswithconcurrencymd) | Executes multiple jobs/operations with a specified level of concurrency. |
+| [withRetry](#variableswithretrymd) | Repeatedly performs an operation until a specified criteria is met. |
-• `Const` **EXPONENTIAL\_SEQUENCE**: `number`[]
+## Classes
-Array of 25 exponential numbers starting from 1 up to 33554432.
-It can be used to form your own backoff interval array.
-**`Example`**
+<a id="classespromiseutilsmd"></a>
-```ts
-// 1ms, 2ms, 4ms, 8ms, 16ms, 32ms
-PromiseUtils.withRetry(() => doSomething(), EXPONENTIAL_SEQUENCE.slice(0, 5), err => err.statusCode === 429);
-// 1s, 2s, 4s, 8s, 10s, 10s, 10s, 10s, 10s, 10s
-PromiseUtils.withRetry(() => doSomething(), Array.from({length: 10}, (_v, i) => 1000 * Math.min(EXPONENTIAL_SEQUENCE[i], 10)), err => err.statusCode === 429);
-// with +-10% randomness: 1s, 2s, 4s, 8s
-PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 4).map(n => 1000 * n * (1 + (Math.random() - 0.5) / 5)), err => err.statusCode === 429);
-```
+### Abstract Class: PromiseUtils
-___
+#### Constructors
-#### FIBONACCI\_SEQUENCE
+<a id="api-constructor"></a>
-• `Const` **FIBONACCI\_SEQUENCE**: `number`[]
+##### Constructor
-Array of 25 Fibonacci numbers starting from 1 up to 317811.
-It can be used to form your own backoff interval array.
+> **new PromiseUtils**(): `PromiseUtils`
-**`Example`**
+###### Returns
-```ts
-// 1ms, 2ms, 3ms, 5ms, 8ms, 13ms
-PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 5), err => err.statusCode === 429);
-// 1s, 2s, 3s, 4s, 8s, 10s, 10s, 10s, 10s, 10s
-PromiseUtils.withRetry(() => doSomething(), Array.from({length: 10}, (_v, i) => 1000 * Math.min(FIBONACCI_SEQUENCE[i], 10)), err => err.statusCode === 429);
-// with +-10% randomness: 1s, 2s, 3s, 5s, 8s, 13s
-PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 5).map(n => 1000 * n * (1 + (Math.random() - 0.5) / 5)), err => err.statusCode === 429);
-```
+`PromiseUtils`
+#### Methods
-### Functions
+<a id="api-cancellabledelayedreject"></a>
-#### cancellableDelayedReject
+##### cancellableDelayedReject()
-▸ **cancellableDelayedReject**\<`T`, `R`\>(`ms`, `reason`): `Object`
+> `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.
+- `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.
+If the `reason` is a PromiseLike that rejects, its rejection value will be used as the rejection reason.
-##### Type parameters
+###### Type Parameters
-| Name | Type |
-| :------ | :------ |
+| Type Parameter | Default type |
+| ------ | ------ |
 | `T` | `never` |
 | `R` | `any` |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+###### Returns
-`Object`
+`object`
-An object with stop() and promise.
+An object with `stop()` and `promise`.
 | Name | Type |
-| :------ | :------ |
+| ------ | ------ |
 | `promise` | `Promise`\<`T`\> |
-| `stop` | () => `void` |
+| `stop()` | () => `void` |
-___
+***
-#### cancellableDelayedResolve
+<a id="api-cancellabledelayedresolve"></a>
-▸ **cancellableDelayedResolve**\<`T`\>(`ms`, `result?`): `Object`
+##### 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.
+- `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.
+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
+###### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+###### Returns
-`Object`
+`object`
-An object with stop() and promise.
+An object with `stop()` and `promise`.
 | Name | Type |
-| :------ | :------ |
+| ------ | ------ |
 | `promise` | `Promise`\<`T`\> |
-| `stop` | () => `void` |
+| `stop()` | () => `void` |
+***
-___
+<a id="api-delayedreject"></a>
-#### delayedReject
+##### delayedReject()
-▸ **delayedReject**\<`T`, `R`\>(`ms`, `reason`): `Promise`\<`T`\>
+> `static` **delayedReject**\<`T`, `R`\>(`ms`, `reason`): `Promise`\<`T`\>
 Creates a Promise that rejects after a specified number of milliseconds.
-The reason argument may be:
+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,
+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
+###### Type Parameters
-| Name | Type |
-| :------ | :------ |
+| Type Parameter | Default type |
+| ------ | ------ |
 | `T` | `never` |
 | `R` | `any` |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+###### Returns
 `Promise`\<`T`\>
 A Promise that rejects with the specified reason after the specified delay.
-___
+***
+<a id="api-delayedresolve"></a>
-#### delayedResolve
+##### delayedResolve()
-▸ **delayedResolve**\<`T`\>(`ms`, `result?`): `Promise`\<`T`\>
+> `static` **delayedResolve**\<`T`\>(`ms`, `result?`): `Promise`\<`T`\>
 Creates a Promise that resolves after a specified number of milliseconds.
-The result argument may be:
+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,
+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
+###### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+###### Returns
 `Promise`\<`T`\>
 A Promise that resolves with the specified result after the specified delay.
-___
+***
+<a id="api-inparallel"></a>
-#### inParallel
+##### inParallel()
-▸ **inParallel**\<`Data`, `Result`, `TError`\>(`parallelism`, `jobs`, `operation`, `options?`): `Promise`\<(`Result` \| `TError`)[]\>
+> `static` **inParallel**\<`Data`, `Result`, `TError`\>(`parallelism`, `jobs`, `operation`, `options?`): `Promise`\<(`Result` \| `TError`)[]\>
 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.
+In most cases, using [PromiseUtils.withConcurrency](#api-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.
+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
+###### Type Parameters
-| Name | Type |
-| :------ | :------ |
-| `Data` | `Data` |
-| `Result` | `Result` |
-| `TError` | `Result` |
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `Data` | - | The type of the job data, typically an Array. |
+| `Result` | - | The type of the return value from the operation function. |
+| `TError` | `Result` | The type for the error that could be thrown from the operation function, defaults to `Result`. |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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. |
+| `operation` | (`job`, `index`) => `Promise`\<`Result`\> | The function that processes job data asynchronously. |
+| `options?` | \{ `abortOnError`: `boolean`; \} | 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
+###### Returns
 `Promise`\<(`Result` \| `TError`)[]\>
@@ -353,298 +369,460 @@ 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.
-___
+###### Example
-#### promiseState
+```ts
+// Capture errors in the returned array
+const attributesAndPossibleErrors: Array<JobResult|JobError> = await PromiseUtils.inParallel(5, topicArns, async (topicArn) => {
+  const topicAttributes = (await sns.getTopicAttributes({ TopicArn: topicArn }).promise()).Attributes!;
+  return topicAttributes;
+});
-▸ **promiseState**(`p`): `Promise`\<[`PromiseState`](#enumspromisestatemd)\>
+// Abort on the first error
+let results: Array<JobResult>;
+try {
+  results = await PromiseUtils.inParallel(100, jobs, async (job) => processor.process(job), { abortOnError: true });
+} catch (error) {
+  // handle the error
+}
+```
+***
+<a id="api-promisestate"></a>
+##### promiseState()
+> `static` **promiseState**(`p`): `Promise`\<`"Pending"` \| `"Fulfilled"` \| `"Rejected"`\>
 Retrieves the state of the specified Promise.
 Note: The returned value is a Promise that resolves immediately.
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `p` | `Promise`\<`any`\> | The Promise whose state is to be determined. |
-##### Returns
+###### Returns
-`Promise`\<[`PromiseState`](#enumspromisestatemd)\>
+`Promise`\<`"Pending"` \| `"Fulfilled"` \| `"Rejected"`\>
 A Promise that resolves immediately with the state of the input Promise.
-___
+***
+<a id="api-repeat"></a>
-#### repeat
+##### repeat()
-▸ **repeat**\<`Result`, `Param`, `Collection`\>(`operation`, `nextParameter`, `collect`, `initialCollection`, `initialParameter?`): `Promise`\<`Collection`\>
+> `static` **repeat**\<`Result`, `Param`, `Collection`\>(`operation`, `nextParameter`, `collect`, `initialCollection`, `initialParameter`): `Promise`\<`Collection`\>
 Executes an operation repeatedly and collects all the results.
 This function is very useful for many scenarios, such like client-side pagination.
-##### Type parameters
+###### Type Parameters
-| Name |
-| :------ |
-| `Result` |
-| `Param` |
-| `Collection` |
+| Type Parameter | Description |
+| ------ | ------ |
+| `Result` | The type of the operation result. |
+| `Param` | The type of the input to the operation, typically a paging parameter. |
+| `Collection` | The type of the collection returned by this function. |
-##### Parameters
+###### Parameters
-| 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. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `operation` | (`parameter`) => `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`) => `Partial`\<`Param`\> \| `Promise`\<`Partial`\<`Param`\>\> \| `null` | 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`, `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
+###### Returns
 `Promise`\<`Collection`\>
 A promise that resolves to a collection of all the results returned by the operation function.
-___
+###### Example
-#### runPeriodically
+```ts
+const domainNameObjects = await PromiseUtils.repeat(
+  pagingParam => apig.getDomainNames({limit: 500, ...pagingParam}).promise(),
+  response => response.position? {position: response.position} : null,
+  (collection, response) => collection.concat(response.items!),
+  [] as APIGateway.DomainName[],
+);
+```
+***
+<a id="api-runperiodically"></a>
-▸ **runPeriodically**\<`T`\>(`operation`, `interval`, `options?`): `Object`
+##### runPeriodically()
+> `static` **runPeriodically**\<`T`\>(`operation`, `interval`, `options?`): `object`
 Runs an operation periodically with configurable intervals and stopping conditions.
-##### Type parameters
+- `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'`.
-| Name |
-| :------ |
-| `T` |
+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`.
-##### Parameters
+###### Type 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"`` | - |
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The operation return type (ignored by the runner; used for typing). |
-##### Returns
+###### Parameters
-`Object`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `operation` | (`iteration`) => `T` \| `Promise`\<`T`\> | Function to run each iteration. Receives the iteration index (1-based). |
+| `interval` | `number` \| `number`[] \| (`iteration`) => `number` \| `undefined` | Number | number[] | ((iteration: number) => number|undefined) defining waits. |
+| `options?` | \{ `maxDurationMs?`: `number`; `maxExecutions?`: `number`; `schedule?`: `"delayAfterEnd"` \| `"delayBetweenStarts"`; \} | Optional configuration. |
+| `options.maxDurationMs?` | `number` | Stop after N milliseconds. |
+| `options.maxExecutions?` | `number` | Stop after N executions. |
+| `options.schedule?` | `"delayAfterEnd"` \| `"delayBetweenStarts"` | How to measure intervals: `'delayAfterEnd'` or `'delayBetweenStarts'`. |
-An object with stop() and done Promise which resolves when the periodic runner stops (or rejects if the operation errors).
+###### 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` |
+| `stop()` | () => `void` |
-___
+***
-#### synchronised
+<a id="api-synchronised"></a>
-▸ **synchronised**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+##### synchronised()
-This is just another spelling of synchronized.
+> `static` **synchronised**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+This is just another spelling of [PromiseUtils.synchronized](#api-synchronized).
-##### Type parameters
+###### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-##### Parameters
+###### 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. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `lock` | `any` | The object (such as a string, a number, or `this` in a class) used to identify the lock. |
+| `operation` | (`previousState`, `previousSettledState`, `previousResult`) => `Promise`\<`T`\> | The function that performs the computation and returns a Promise. |
-##### Returns
+###### Returns
 `Promise`\<`T`\>
 The result of the operation function.
-___
+***
-#### synchronized
+<a id="api-synchronized"></a>
-▸ **synchronized**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+##### synchronized()
-Provides mutual exclusion similar to synchronized in Java.
+> `static` **synchronized**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+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),
+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
+###### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-##### Parameters
+###### 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. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `lock` | `any` | The object (such as a string, a number, or `this` in a class) used to identify the lock. |
+| `operation` | (`previousState`, `previousSettledState`, `previousResult`) => `Promise`\<`T`\> | The function that performs the computation and returns a Promise. |
-##### Returns
+###### Returns
 `Promise`\<`T`\>
 The result of the operation function.
-___
+***
-#### timeoutReject
+<a id="api-timeoutreject"></a>
-▸ **timeoutReject**\<`T`, `R`\>(`operation`, `ms`, `rejectReason`): `Promise`\<`T`\>
+##### timeoutReject()
+> `static` **timeoutReject**\<`T`, `R`\>(`operation`, `ms`, `rejectReason`): `Promise`\<`T`\>
 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."
+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
+###### Type Parameters
-| Name | Type |
-| :------ | :------ |
+| Type Parameter | Default type |
+| ------ | ------ |
 | `T` | `never` |
 | `R` | `any` |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+###### Returns
 `Promise`\<`T`\>
 A new Promise that rejects with the specified reason if the timeout occurs.
-___
+***
-#### timeoutResolve
+<a id="api-timeoutresolve"></a>
-▸ **timeoutResolve**\<`T`\>(`operation`, `ms`, `result?`): `Promise`\<`T`\>
+##### timeoutResolve()
+> `static` **timeoutResolve**\<`T`\>(`operation`, `ms`, `result?`): `Promise`\<`T`\>
 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.
+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
+###### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-##### Parameters
+###### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+###### Returns
 `Promise`\<`T`\>
 A new Promise that resolves to the specified result if the timeout occurs.
-___
+***
-#### withConcurrency
+<a id="api-withconcurrency"></a>
-▸ **withConcurrency**\<`Data`, `Result`\>(`concurrency`, `jobs`, `operation`): `Promise`\<`Result`[]\>
+##### withConcurrency()
+> `static` **withConcurrency**\<`Data`, `Result`\>(`concurrency`, `jobs`, `operation`): `Promise`\<`Result`[]\>
 Executes multiple jobs/operations with a specified level of concurrency.
-##### Type parameters
+Unlike `inParallel(...)`, this function may throw or reject an error when a job/operation fails.
+When an error is re-thrown, remaining operations will not be executed.
+If you want all the operations to always be executed, use [PromiseUtils.inParallel](#api-inparallel) instead.
-| Name |
-| :------ |
-| `Data` |
-| `Result` |
+###### Type Parameters
-##### Parameters
+| Type Parameter | Description |
+| ------ | ------ |
+| `Data` | The type of the job data, typically an Array. |
+| `Result` | The type of the return value from the operation function. |
-| Name | Type | Description |
-| :------ | :------ | :------ |
+###### Parameters
+| Parameter | 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. |
+| `operation` | (`job`, `index`) => `Promise`\<`Result`\> | The function that processes job data asynchronously. |
-##### Returns
+###### 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.
-___
+###### Example
+```ts
+// At any time, there would be no more than 5 concurrency API calls. Error would be re-thrown immediately when it occurs.
+const attributes = await PromiseUtils.withConcurrency(5, topicArns, async (topicArn) => {
+  const topicAttributes = (await sns.getTopicAttributes({ TopicArn: topicArn }).promise()).Attributes!;
+  return topicAttributes;
+});
+```
+***
-#### withRetry
+<a id="api-withretry"></a>
-▸ **withRetry**\<`Result`, `TError`\>(`operation`, `backoff`, `shouldRetry?`): `Promise`\<`Result`\>
+##### withRetry()
+> `static` **withRetry**\<`Result`, `TError`\>(`operation`, `backoff`, `shouldRetry`): `Promise`\<`Result`\>
 Repeatedly performs an operation until a specified criteria is met.
-##### Type parameters
+###### Type Parameters
-| Name | Type |
-| :------ | :------ |
-| `Result` | `Result` |
-| `TError` | `any` |
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `Result` | - | Type of the operation result. |
+| `TError` | `any` | Type of the possible error that could be generated by the operation. |
-##### Parameters
+###### Parameters
-| 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. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `operation` | (`attempt`, `previousResult`, `previousError`) => `Promise`\<`Result`\> | A function that outputs a Promise result. Typically, the operation does not use its arguments. |
+| `backoff` | `number`[] \| (`attempt`, `previousResult`, `previousError`) => `number` \| `undefined` | An array of retry backoff periods (in milliseconds) or a function for calculating them. If retry is desired, the specified backoff period is waited before the next call to the operation. If the array runs out of elements or the function returns `undefined` or a negative number, no further calls to the operation will be made. The `attempt` argument passed to the backoff function starts from 1, as it is called immediately after the first attempt and before the first retry. |
+| `shouldRetry` | (`previousError`, `previousResult`, `attempt`) => `boolean` | A predicate function for deciding whether another call to the operation should occur. If this argument is not defined, a retry will occur whenever the operation rejects with an error. The `shouldRetry` function is evaluated before the `backoff`. The `attempt` argument passed to the shouldRetry function starts from 1. |
-##### Returns
+###### Returns
 `Promise`\<`Result`\>
 A promise of the operation result, potentially with retries applied.
-## Classes
+###### Example
+```ts
+const result = await PromiseUtils.withRetry(() => doSomething(), [100, 200, 300, 500, 800, 1000]);
+const result2 = await PromiseUtils.withRetry(() => doSomething(), Array.from({length: 10}, (_v, i) => 1000 * Math.min(FIBONACCI_SEQUENCE[i], 10), err => err.statusCode === 429);
+const result3 = await PromiseUtils.withRetry(() => doSomething(), attempt => attempt <= 8 ? 1000 * Math.min(FIBONACCI_SEQUENCE[attempt - 1], 10) : undefined, err => err.statusCode === 429);
+```
-<a name="classespromiseutilsmd"></a>
+## Type Aliases
-### Class: PromiseUtils
-#### Constructors
+<a id="type-aliasespromisestatetypemd"></a>
-##### constructor
+### Type Alias: PromiseStateType
-• **new PromiseUtils**()
+> **PromiseStateType** = keyof *typeof* [`PromiseState`](#variablespromisestate-1md)
+## Variables
-#### Methods
-##### cancellableDelayedReject
+<a id="variablesexponential_sequencemd"></a>
-▸ `Static` **cancellableDelayedReject**\<`T`, `R`\>(`ms`, `reason`): `Object`
+### Variable: EXPONENTIAL\_SEQUENCE
+> `const` **EXPONENTIAL\_SEQUENCE**: `number`[]
+Array of 25 exponential numbers starting from 1 up to 33554432.
+It can be used to form your own backoff interval array.
+#### Example
+```ts
+// 1ms, 2ms, 4ms, 8ms, 16ms, 32ms
+PromiseUtils.withRetry(() => doSomething(), EXPONENTIAL_SEQUENCE.slice(0, 5), err => err.statusCode === 429);
+// 1s, 2s, 4s, 8s, 10s, 10s, 10s, 10s, 10s, 10s
+PromiseUtils.withRetry(() => doSomething(), Array.from({length: 10}, (_v, i) => 1000 * Math.min(EXPONENTIAL_SEQUENCE[i], 10)), err => err.statusCode === 429);
+// with +-10% randomness: 1s, 2s, 4s, 8s
+PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 4).map(n => 1000 * n * (1 + (Math.random() - 0.5) / 5)), err => err.statusCode === 429);
+```
+<a id="variablesfibonacci_sequencemd"></a>
+### Variable: FIBONACCI\_SEQUENCE
+> `const` **FIBONACCI\_SEQUENCE**: `number`[]
+Array of 25 Fibonacci numbers starting from 1 up to 317811.
+It can be used to form your own backoff interval array.
+#### Example
+```ts
+// 1ms, 2ms, 3ms, 5ms, 8ms, 13ms
+PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 5), err => err.statusCode === 429);
+// 1s, 2s, 3s, 4s, 8s, 10s, 10s, 10s, 10s, 10s
+PromiseUtils.withRetry(() => doSomething(), Array.from({length: 10}, (_v, i) => 1000 * Math.min(FIBONACCI_SEQUENCE[i], 10)), err => err.statusCode === 429);
+// with +-10% randomness: 1s, 2s, 3s, 5s, 8s, 13s
+PromiseUtils.withRetry(() => doSomething(), FIBONACCI_SEQUENCE.slice(0, 5).map(n => 1000 * n * (1 + (Math.random() - 0.5) / 5)), err => err.statusCode === 429);
+```
+<a id="variablespromisestate-1md"></a>
+### Variable: PromiseState
+> `const` **PromiseState**: `object`
+The state of a Promise can only be one of: Pending, Fulfilled, and Rejected.
+#### Type Declaration
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| <a id="api-fulfilled"></a> `Fulfilled` | `"Fulfilled"` | `'Fulfilled'` |
+| <a id="api-pending"></a> `Pending` | `"Pending"` | `'Pending'` |
+| <a id="api-rejected"></a> `Rejected` | `"Rejected"` | `'Rejected'` |
+<a id="variablescancellabledelayedrejectmd"></a>
+### Variable: cancellableDelayedReject()
+> `const` **cancellableDelayedReject**: \<`T`, `R`\>(`ms`, `reason`) => `object` = `PromiseUtils.cancellableDelayedReject`
+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.
 Creates a cancellable timer that will reject after a specified number of milliseconds.
@@ -656,36 +834,59 @@ The returned object contains:
 If the `reason` is a PromiseLike that rejects, its rejection value will be used as the rejection reason.
-###### Type parameters
+#### Type Parameters
-| Name | Type |
-| :------ | :------ |
+| Type Parameter | Default type |
+| ------ | ------ |
 | `T` | `never` |
 | `R` | `any` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+#### Returns
-`Object`
+`object`
 An object with `stop()` and `promise`.
 | Name | Type |
-| :------ | :------ |
+| ------ | ------ |
 | `promise` | `Promise`\<`T`\> |
-| `stop` | () => `void` |
+| `stop()` | () => `void` |
+#### Param
-___
+The number of milliseconds after which the scheduled rejection will occur.
-##### cancellableDelayedResolve
+#### Param
+The reason for the rejection, or a function that supplies the reason.
+#### Returns
+An object with stop() and promise.
+<a id="variablescancellabledelayedresolvemd"></a>
+### Variable: cancellableDelayedResolve()
+> `const` **cancellableDelayedResolve**: \<`T`\>(`ms`, `result?`) => `object` = `PromiseUtils.cancellableDelayedResolve`
+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.
-▸ `Static` **cancellableDelayedResolve**\<`T`\>(`ms`, `result?`): `Object`
+If the result is a PromiseLike, its resolution value will be used as the resolved value.
 Creates a cancellable timer that will resolve after a specified number of milliseconds.
@@ -698,35 +899,59 @@ The returned object contains:
 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
+#### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+#### Returns
-`Object`
+`object`
 An object with `stop()` and `promise`.
 | Name | Type |
-| :------ | :------ |
+| ------ | ------ |
 | `promise` | `Promise`\<`T`\> |
-| `stop` | () => `void` |
+| `stop()` | () => `void` |
+#### Param
+The number of milliseconds after which the scheduled resolution will occur.
+#### Param
+The result to be resolved by the Promise, or a function that supplies the result.
+#### Returns
+An object with stop() and promise.
+<a id="variablesdelayedrejectmd"></a>
-___
+### Variable: delayedReject()
-##### delayedReject
+> `const` **delayedReject**: \<`T`, `R`\>(`ms`, `reason`) => `Promise`\<`T`\> = `PromiseUtils.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).
 Creates a Promise that rejects after a specified number of milliseconds.
@@ -739,31 +964,54 @@ If `reason` is a function, it is called when the timer elapses; if it returns a
 the returned Promise will reject with that Promise's rejection reason (or reject with the
 returned value if it resolves).
-###### Type parameters
+#### Type Parameters
-| Name | Type |
-| :------ | :------ |
+| Type Parameter | Default type |
+| ------ | ------ |
 | `T` | `never` |
 | `R` | `any` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+#### Returns
 `Promise`\<`T`\>
 A Promise that rejects with the specified reason after the specified delay.
-___
+#### Param
+The number of milliseconds after which the created Promise will reject.
+#### Param
+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.
+<a id="variablesdelayedresolvemd"></a>
+### Variable: delayedResolve()
+> `const` **delayedResolve**: \<`T`\>(`ms`, `result?`) => `Promise`\<`T`\> = `PromiseUtils.delayedResolve`
+Creates a Promise that resolves after a specified number of milliseconds.
-##### delayedResolve
+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.
-▸ `Static` **delayedResolve**\<`T`\>(`ms`, `result?`): `Promise`\<`T`\>
+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.
 Creates a Promise that resolves after a specified number of milliseconds.
@@ -775,33 +1023,56 @@ The `result` argument may be:
 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
+#### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+#### Returns
 `Promise`\<`T`\>
 A Promise that resolves with the specified result after the specified delay.
-___
+#### Param
+The number of milliseconds after which the created Promise will resolve.
+#### Param
+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.
-##### inParallel
+<a id="variablesinparallelmd"></a>
+### Variable: inParallel()
+> `const` **inParallel**: \<`Data`, `Result`, `TError`\>(`parallelism`, `jobs`, `operation`, `options?`) => `Promise`\<(`Result` \| `TError`)[]\> = `PromiseUtils.inParallel`
+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).
-▸ `Static` **inParallel**\<`Data`, `Result`, `TError`\>(`parallelism`, `jobs`, `operation`, `options?`): `Promise`\<(`Result` \| `TError`)[]\>
+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.
 Executes multiple jobs/operations in parallel. By default, all operations are executed regardless of any failures.
-In most cases, using [withConcurrency](#withconcurrency) might be more convenient.
+In most cases, using [PromiseUtils.withConcurrency](#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.
@@ -810,25 +1081,25 @@ This function only resolves when all jobs/operations are settled (either resolve
 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
+#### Type Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `Data` | `Data` | The type of the job data, typically an Array. |
-| `Result` | `Result` | The type of the return value from the operation function. |
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `Data` | - | The type of the job data, typically an Array. |
+| `Result` | - | The type of the return value from the operation function. |
 | `TError` | `Result` | The type for the error that could be thrown from the operation function, defaults to `Result`. |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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. |
+| `operation` | (`job`, `index`) => `Promise`\<`Result`\> | The function that processes job data asynchronously. |
+| `options?` | \{ `abortOnError`: `boolean`; \} | 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
+#### Returns
 `Promise`\<(`Result` \| `TError`)[]\>
@@ -836,7 +1107,7 @@ 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.
-**`Example`**
+#### Example
 ```ts
 // Capture errors in the returned array
@@ -854,61 +1125,103 @@ try {
 }
 ```
-___
+#### Param
+The number of jobs/operations to run concurrently.
+#### Param
+The job data to be processed. This function can safely handle an infinite or unknown number of elements.
+#### Param
+The function that processes job data asynchronously.
+#### Param
+Options to control the function's behavior.
+#### Param
+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.
-##### promiseState
+<a id="variablespromisestatemd"></a>
-▸ `Static` **promiseState**(`p`): `Promise`\<[`PromiseState`](#enumspromisestatemd)\>
+### Variable: promiseState()
+> `const` **promiseState**: (`p`) => `Promise`\<`"Pending"` \| `"Fulfilled"` \| `"Rejected"`\> = `PromiseUtils.promiseState`
 Retrieves the state of the specified Promise.
 Note: The returned value is a Promise that resolves immediately.
-###### Parameters
+Retrieves the state of the specified Promise.
+Note: The returned value is a Promise that resolves immediately.
-| Name | Type | Description |
-| :------ | :------ | :------ |
+#### Parameters
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `p` | `Promise`\<`any`\> | The Promise whose state is to be determined. |
-###### Returns
+#### Returns
+`Promise`\<`"Pending"` \| `"Fulfilled"` \| `"Rejected"`\>
+A Promise that resolves immediately with the state of the input Promise.
+#### Param
-`Promise`\<[`PromiseState`](#enumspromisestatemd)\>
+The Promise whose state is to be determined.
+#### Returns
 A Promise that resolves immediately with the state of the input Promise.
-___
-##### repeat
+<a id="variablesrepeatmd"></a>
+### Variable: repeat()
-▸ `Static` **repeat**\<`Result`, `Param`, `Collection`\>(`operation`, `nextParameter`, `collect`, `initialCollection`, `initialParameter?`): `Promise`\<`Collection`\>
+> `const` **repeat**: \<`Result`, `Param`, `Collection`\>(`operation`, `nextParameter`, `collect`, `initialCollection`, `initialParameter`) => `Promise`\<`Collection`\> = `PromiseUtils.repeat`
 Executes an operation repeatedly and collects all the results.
 This function is very useful for many scenarios, such like client-side pagination.
-###### Type parameters
+Executes an operation repeatedly and collects all the results.
+This function is very useful for many scenarios, such like client-side pagination.
-| Name | Description |
-| :------ | :------ |
+#### Type Parameters
+| Type Parameter | Description |
+| ------ | ------ |
 | `Result` | The type of the operation result. |
 | `Param` | The type of the input to the operation, typically a paging parameter. |
 | `Collection` | The type of the collection returned by this function. |
-###### Parameters
+#### Parameters
-| 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. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `operation` | (`parameter`) => `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`) => `Partial`\<`Param`\> \| `Promise`\<`Partial`\<`Param`\>\> \| `null` | 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`, `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
+#### Returns
 `Promise`\<`Collection`\>
 A promise that resolves to a collection of all the results returned by the operation function.
-**`Example`**
+#### Example
 ```ts
 const domainNameObjects = await PromiseUtils.repeat(
@@ -919,11 +1232,62 @@ const domainNameObjects = await PromiseUtils.repeat(
 );
 ```
-___
+#### Param
+A function that takes a parameter as input and returns a result. Typically, the parameter has optional fields to control paging.
+#### 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.
+#### Param
+A function for merging the operation result into the collection.
+#### Param
+The initial collection, which will be the first argument passed to the first invocation of the collect function.
+#### Param
+The parameter for the first operation.
+#### Returns
+A promise that resolves to a collection of all the results returned by the operation function.
+<a id="variablesrunperiodicallymd"></a>
+### Variable: runPeriodically()
+> `const` **runPeriodically**: \<`T`\>(`operation`, `interval`, `options?`) => `object` = `PromiseUtils.runPeriodically`
+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'`.
-##### runPeriodically
+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.
-▸ `Static` **runPeriodically**\<`T`\>(`operation`, `interval`, `options?`): `Object`
+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`.
 Runs an operation periodically with configurable intervals and stopping conditions.
@@ -951,67 +1315,123 @@ 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
+#### Type Parameters
-| Name | Description |
-| :------ | :------ |
+| Type Parameter | Description |
+| ------ | ------ |
 | `T` | The operation return type (ignored by the runner; used for typing). |
-###### Parameters
+#### 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"`` | - |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `operation` | (`iteration`) => `T` \| `Promise`\<`T`\> | Function to run each iteration. Receives the iteration index (1-based). |
+| `interval` | `number` \| `number`[] \| (`iteration`) => `number` \| `undefined` | Number | number[] | ((iteration: number) => number|undefined) defining waits. |
+| `options?` | \{ `maxDurationMs?`: `number`; `maxExecutions?`: `number`; `schedule?`: `"delayAfterEnd"` \| `"delayBetweenStarts"`; \} | Optional configuration. |
+| `options.maxDurationMs?` | `number` | Stop after N milliseconds. |
+| `options.maxExecutions?` | `number` | Stop after N executions. |
+| `options.schedule?` | `"delayAfterEnd"` \| `"delayBetweenStarts"` | How to measure intervals: `'delayAfterEnd'` or `'delayBetweenStarts'`. |
-###### Returns
+#### Returns
-`Object`
+`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` |
+| `stop()` | () => `void` |
+#### Template
+The operation return type (ignored by the runner; used for typing).
+#### Param
+Function to run each iteration. Receives the iteration index (1-based).
+#### Param
+Number | number[] | ((iteration: number) => number|undefined) defining waits.
+#### Param
+Optional configuration.
+#### Param
+Stop after N executions.
+#### Param
+Stop after N milliseconds.
+#### Param
+How to measure intervals: `'delayAfterEnd'` or `'delayBetweenStarts'`.
+#### 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).
-___
+<a id="variablessynchronisedmd"></a>
-##### synchronised
+### Variable: synchronised()
-▸ `Static` **synchronised**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+> `const` **synchronised**: \<`T`\>(`lock`, `operation`) => `Promise`\<`T`\> = `PromiseUtils.synchronised`
+This is just another spelling of synchronized.
-This is just another spelling of [synchronized](#synchronized).
+This is just another spelling of [PromiseUtils.synchronized](#synchronized).
-###### Type parameters
+#### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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. |
+| `operation` | (`previousState`, `previousSettledState`, `previousResult`) => `Promise`\<`T`\> | The function that performs the computation and returns a Promise. |
-###### Returns
+#### Returns
 `Promise`\<`T`\>
 The result of the operation function.
-___
+#### Param
+The object (such as a string, a number, or this in a class) used to identify the lock.
+#### Param
+The function that performs the computation and returns a Promise.
+#### Returns
+The result of the operation function.
+<a id="variablessynchronizedmd"></a>
-##### synchronized
+### Variable: synchronized()
-▸ `Static` **synchronized**\<`T`\>(`lock`, `operation`): `Promise`\<`T`\>
+> `const` **synchronized**: \<`T`\>(`lock`, `operation`) => `Promise`\<`T`\> = `PromiseUtils.synchronized`
+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.
 Provides mutual exclusion similar to `synchronized` in Java.
 Ensures no concurrent execution of any operation function associated with the same lock.
@@ -1020,30 +1440,49 @@ 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
+#### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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. |
+| `operation` | (`previousState`, `previousSettledState`, `previousResult`) => `Promise`\<`T`\> | The function that performs the computation and returns a Promise. |
-###### Returns
+#### Returns
 `Promise`\<`T`\>
 The result of the operation function.
-___
+#### Param
+The object (such as a string, a number, or this in a class) used to identify the lock.
+#### Param
+The function that performs the computation and returns a Promise.
+#### Returns
+The result of the operation function.
+<a id="variablestimeoutrejectmd"></a>
+### Variable: timeoutReject()
-##### timeoutReject
+> `const` **timeoutReject**: \<`T`, `R`\>(`operation`, `ms`, `rejectReason`) => `Promise`\<`T`\> = `PromiseUtils.timeoutReject`
-▸ `Static` **timeoutReject**\<`T`, `R`\>(`operation`, `ms`, `rejectReason`): `Promise`\<`T`\>
+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."
 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.
@@ -1051,32 +1490,56 @@ If the timeout does not occur, the returned Promise resolves or rejects based on
 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
+#### Type Parameters
-| Name | Type |
-| :------ | :------ |
+| Type Parameter | Default type |
+| ------ | ------ |
 | `T` | `never` |
 | `R` | `any` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+#### Returns
 `Promise`\<`T`\>
 A new Promise that rejects with the specified reason if the timeout occurs.
-___
+#### Param
+The original Promise or a function that returns a Promise to which the timeout will be applied.
+#### Param
+The number of milliseconds for the timeout.
+#### Param
+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.
+<a id="variablestimeoutresolvemd"></a>
-##### timeoutResolve
+### Variable: timeoutResolve()
-▸ `Static` **timeoutResolve**\<`T`\>(`operation`, `ms`, `result?`): `Promise`\<`T`\>
+> `const` **timeoutResolve**: \<`T`\>(`operation`, `ms`, `result?`) => `Promise`\<`T`\> = `PromiseUtils.timeoutResolve`
+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."
 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.
@@ -1085,61 +1548,80 @@ If the `result` parameter is a function and the timeout does not occur, the func
 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
+#### Type Parameters
-| Name |
-| :------ |
+| Type Parameter |
+| ------ |
 | `T` |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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
+#### Returns
 `Promise`\<`T`\>
 A new Promise that resolves to the specified result if the timeout occurs.
-___
+#### Param
+The original Promise or a function that returns a Promise to which the timeout will be applied.
+#### Param
+The number of milliseconds for the timeout.
+#### Param
+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.
-##### withConcurrency
+<a id="variableswithconcurrencymd"></a>
-▸ `Static` **withConcurrency**\<`Data`, `Result`\>(`concurrency`, `jobs`, `operation`): `Promise`\<`Result`[]\>
+### Variable: withConcurrency()
+> `const` **withConcurrency**: \<`Data`, `Result`\>(`concurrency`, `jobs`, `operation`) => `Promise`\<`Result`[]\> = `PromiseUtils.withConcurrency`
+Executes multiple jobs/operations with a specified level of concurrency.
 Executes multiple jobs/operations with a specified level of concurrency.
 Unlike `inParallel(...)`, this function may throw or reject an error when a job/operation fails.
 When an error is re-thrown, remaining operations will not be executed.
-If you want all the operations to always be executed, use [inParallel](#inparallel) instead.
+If you want all the operations to always be executed, use [PromiseUtils.inParallel](#inparallel) instead.
-###### Type parameters
+#### Type Parameters
-| Name | Description |
-| :------ | :------ |
+| Type Parameter | Description |
+| ------ | ------ |
 | `Data` | The type of the job data, typically an Array. |
 | `Result` | The type of the return value from the operation function. |
-###### Parameters
+#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
+| Parameter | 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. |
+| `operation` | (`job`, `index`) => `Promise`\<`Result`\> | The function that processes job data asynchronously. |
-###### Returns
+#### 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.
-**`Example`**
+#### Example
 ```ts
 // At any time, there would be no more than 5 concurrency API calls. Error would be re-thrown immediately when it occurs.
@@ -1149,36 +1631,56 @@ const attributes = await PromiseUtils.withConcurrency(5, topicArns, async (topic
 });
 ```
-___
+#### Param
+The number of jobs/operations to run concurrently.
+#### Param
+The job data to be processed. This function can handle an infinite or unknown number of elements safely.
+#### Param
+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.
+<a id="variableswithretrymd"></a>
-##### withRetry
+### Variable: withRetry()
-▸ `Static` **withRetry**\<`Result`, `TError`\>(`operation`, `backoff`, `shouldRetry?`): `Promise`\<`Result`\>
+> `const` **withRetry**: \<`Result`, `TError`\>(`operation`, `backoff`, `shouldRetry`) => `Promise`\<`Result`\> = `PromiseUtils.withRetry`
 Repeatedly performs an operation until a specified criteria is met.
-###### Type parameters
+Repeatedly performs an operation until a specified criteria is met.
+#### Type Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `Result` | `Result` | Type of the operation result. |
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `Result` | - | Type of the operation result. |
 | `TError` | `any` | Type of the possible error that could be generated by the operation. |
-###### Parameters
+#### Parameters
-| 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. If retry is desired, the specified backoff period is waited before the next call to the operation. If the array runs out of elements or the function returns `undefined` or a negative number, no further calls to the operation will be made. The `attempt` argument passed to the backoff function starts from 1, as it is called immediately after the first attempt and before the first retry. |
-| `shouldRetry` | (`previousError`: `undefined` \| `TError`, `previousResult`: `undefined` \| `Result`, `attempt`: `number`) => `boolean` | A predicate function for deciding whether another call to the operation should occur. If this argument is not defined, a retry will occur whenever the operation rejects with an error. The `shouldRetry` function is evaluated before the `backoff`. The `attempt` argument passed to the shouldRetry function starts from 1. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `operation` | (`attempt`, `previousResult`, `previousError`) => `Promise`\<`Result`\> | A function that outputs a Promise result. Typically, the operation does not use its arguments. |
+| `backoff` | `number`[] \| (`attempt`, `previousResult`, `previousError`) => `number` \| `undefined` | An array of retry backoff periods (in milliseconds) or a function for calculating them. If retry is desired, the specified backoff period is waited before the next call to the operation. If the array runs out of elements or the function returns `undefined` or a negative number, no further calls to the operation will be made. The `attempt` argument passed to the backoff function starts from 1, as it is called immediately after the first attempt and before the first retry. |
+| `shouldRetry` | (`previousError`, `previousResult`, `attempt`) => `boolean` | A predicate function for deciding whether another call to the operation should occur. If this argument is not defined, a retry will occur whenever the operation rejects with an error. The `shouldRetry` function is evaluated before the `backoff`. The `attempt` argument passed to the shouldRetry function starts from 1. |
-###### Returns
+#### Returns
 `Promise`\<`Result`\>
 A promise of the operation result, potentially with retries applied.
-**`Example`**
+#### Example
 ```ts
 const result = await PromiseUtils.withRetry(() => doSomething(), [100, 200, 300, 500, 800, 1000]);
@@ -1186,30 +1688,19 @@ const result2 = await PromiseUtils.withRetry(() => doSomething(), Array.from({le
 const result3 = await PromiseUtils.withRetry(() => doSomething(), attempt => attempt <= 8 ? 1000 * Math.min(FIBONACCI_SEQUENCE[attempt - 1], 10) : undefined, err => err.statusCode === 429);
 ```
-## Enums
+#### Param
+A function that outputs a Promise result. Typically, the operation does not use its arguments.
-<a name="enumspromisestatemd"></a>
+#### Param
-### Enumeration: PromiseState
+An array of retry backoff periods (in milliseconds) or a function for calculating them.
-The state of a Promise can only be one of: Pending, Fulfilled, and Rejected.
-#### Enumeration Members
-##### Fulfilled
-• **Fulfilled** = ``"Fulfilled"``
+#### Param
-___
+A predicate function for deciding whether another call to the operation should occur.
-##### Pending
+#### Returns
-• **Pending** = ``"Pending"``
-___
-##### Rejected
-• **Rejected** = ``"Rejected"``
+A promise of the operation result, potentially with retries applied.
 <!-- API end -->