@rushstack/node-core-library - npm Package Compare versions

Comparing version 3.49.0 to 3.50.0

lib/Async.d.ts

@@ -17,2 +17,13 @@ /**
 /**
+ * @remarks
+ * Used with {@link Async.runWithRetriesAsync}.
+ *
+ * @beta
+ */
+export interface IRunWithRetriesOptions<TResult> {
+    action: () => Promise<TResult> | TResult;
+    maxRetries: number;
+    retryDelayMs?: number;
+}
+/**
  * Utilities for parallel asynchronous operations, for use with the system `Promise` APIs.
@@ -67,3 +78,7 @@ *
     static sleep(ms: number): Promise<void>;
+    /**
+     * Executes an async function and optionally retries it if it fails.
+     */
+    static runWithRetriesAsync<TResult>({ action, maxRetries, retryDelayMs }: IRunWithRetriesOptions<TResult>): Promise<TResult>;
 }
 //# sourceMappingURL=Async.d.ts.map

lib/Async.js

@@ -119,4 +119,24 @@ "use strict";
     }
+    /**
+     * Executes an async function and optionally retries it if it fails.
+     */
+    static async runWithRetriesAsync({ action, maxRetries, retryDelayMs = 0 }) {
+        let retryCounter = 0;
+        // eslint-disable-next-line no-constant-condition
+        while (true) {
+            try {
+                return await action();
+            }
+            catch (e) {
+                if (++retryCounter > maxRetries) {
+                    throw e;
+                }
+                else if (retryDelayMs > 0) {
+                    await Async.sleep(retryDelayMs);
+                }
+            }
+        }
+    }
 }
 exports.Async = Async;
 //# sourceMappingURL=Async.js.map

lib/index.d.ts

@@ -8,3 +8,3 @@ /**
 export { AnsiEscape, IAnsiEscapeConvertForTestsOptions } from './Terminal/AnsiEscape';
-export { Async, IAsyncParallelismOptions } from './Async';
+export { Async, IAsyncParallelismOptions, IRunWithRetriesOptions } from './Async';
 export { Brand } from './PrimitiveTypes';
@@ -11,0 +11,0 @@ export { FileConstants, FolderConstants } from './Constants';

package.json

 {
   "name": "@rushstack/node-core-library",
-  "version": "3.49.0",
+  "version": "3.50.0",
   "description": "Core libraries that every NodeJS toolchain project should use",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

1010218

0.31%

Lines of code

13264

0.38%

No dependency changes