docs: explain config.onComplete execution

AriPerkkio · Jan 3, 2021 · 376c7d5 · 376c7d5
1 parent 81f4e76
commit 376c7d5
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/progress-logger/progress-logger.ts b/lib/progress-logger/progress-logger.ts
@@ -174,8 +174,13 @@ class ProgressLogger {
         const notifyListeners = () =>
             this.listeners.exit.forEach(listener => listener());
 
+        // Default promise to use if config.onComplete is not defined, or it
+        // is a synchronous method.
         let exitPromise = Promise.resolve();
 
+        // Execute possible onComplete before notifying exit-listeners.
+        // It's essential to not crash whole application if user provided
+        // onComplete callback throws error. Log the error and move on.
         if (config.onComplete) {
             const results = ResultsStore.getResults();
             try {