message-await 0.2.0 → 0.4.0

package/dist/src/contracts.d.ts

@@ -14,16 +14,7 @@ export declare type MessageAwaitOptions = {
      */
     hideCursor: boolean;
 };
-export declare type MessageAwait = {
-    /**
-     * awaits the completion of a promise and marks the message as success or failure based on the promise
-     * @param promise
-     * @param exitProcess - if the promise is rejected exits the node process. Defaults to false
-     * @param printError - if the promise is rejected prints the error that is returned. Defaults to false
-     * @param updateSuccessMessage - optional. update the message on success
-     * @param updateFailureMessage - optional. update the message on rejection
-     */
-    await: <T>(promise: Promise<T>, exitProcess?: boolean, printError?: boolean, updateSuccessMessage?: string, updateFailureMessage?: string) => Promise<T>;
+export interface UpdateMessage {
     /**
      * marks the message as complete.
      * @param success - defaults to true. Adds a tick or a cross to the message
@@ -53,4 +44,15 @@ export declare type MessageAwait = {
      * gets the currently displayed message
      */
     getMessage: () => string;
-};
+}
+export interface MessageAwait extends UpdateMessage {
+    /**
+     * awaits the completion of a promise and marks the message as success or failure based on the promise
+     * @param promise
+     * @param exitProcess - if the promise is rejected exits the node process. Defaults to false
+     * @param printError - if the promise is rejected prints the error that is returned. Defaults to false
+     * @param updateSuccessMessage - optional. update the message on success
+     * @param updateFailureMessage - optional. update the message on rejection
+     */
+    await: <T>(promise: Promise<T> | ((updateMessage: UpdateMessage) => Promise<T>), exitProcess?: boolean, printError?: boolean, updateSuccessMessage?: string | ((result: T) => string), updateFailureMessage?: string | ((error: unknown) => string)) => Promise<T>;
+}

package/dist/src/index.js

@@ -12,7 +12,11 @@ var __assign = (this && this.__assign) || function () {
 };
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -20,12 +24,14 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __spreadArrays = (this && this.__spreadArrays) || function () {
-    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
-    for (var r = Array(s), k = 0, i = 0; i < il; i++)
-        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
-            r[k] = a[j];
-    return r;
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var readline_1 = require("readline");
@@ -55,8 +61,8 @@ function print(message, options) {
         return requiredOptions.format(message + dots);
     }
     function resetCursor() {
-        readline_1.cursorTo(process.stdout, 0);
-        readline_1.clearLine(process.stdout, 1);
+        (0, readline_1.cursorTo)(process.stdout, 0);
+        (0, readline_1.clearLine)(process.stdout, 1);
     }
     function writeMessage() {
         resetCursor();
@@ -101,7 +107,7 @@ function print(message, options) {
             throw new Error("Progress Message is complete");
         }
         resetCursor();
-        console.log.apply(console, __spreadArrays([logMessage], optional));
+        console.log.apply(console, __spreadArray([logMessage], optional, false));
         writeMessage();
     }
     function complete(success, updateMessage) {
@@ -114,13 +120,13 @@ function print(message, options) {
         resetCursor();
         message = updateMessage || message;
         if (success) {
-            console.log(generateMessage() + " " + logSymbols.success);
+            console.log("".concat(generateMessage(), " ").concat(logSymbols.success));
         }
         else {
-            console.log(generateMessage() + " " + logSymbols.error);
+            console.log("".concat(generateMessage(), " ").concat(logSymbols.error));
         }
         if (requiredOptions.hideCursor) {
-            cli_cursor_1.show();
+            (0, cli_cursor_1.show)();
         }
     }
     function success(updateMessage) {
@@ -129,14 +135,19 @@ function print(message, options) {
     function fail(updateMessage) {
         return complete(false, updateMessage);
     }
+    function getMessage() {
+        return message;
+    }
     function await(promise, exitProcess, printError, updateSuccessMessage, updateFailureMessage) {
-        return promise
+        return (typeof promise === 'function'
+            ? promise({ complete: complete, log: log, updateMessage: updateMessage, getMessage: getMessage, success: success, fail: fail })
+            : promise)
             .then(function (value) {
-            complete(true, updateSuccessMessage);
+            complete(true, typeof updateSuccessMessage === 'function' ? updateSuccessMessage(value) : updateSuccessMessage);
             return value;
         })
             .catch(function (err) {
-            complete(false, updateFailureMessage);
+            complete(false, typeof updateFailureMessage === 'function' ? updateFailureMessage(err) : updateFailureMessage);
             if (printError) {
                 console.error(err);
             }
@@ -146,11 +157,8 @@ function print(message, options) {
             return Promise.reject(err);
         });
     }
-    function getMessage() {
-        return message;
-    }
     if (requiredOptions.hideCursor) {
-        cli_cursor_1.hide();
+        (0, cli_cursor_1.hide)();
     }
     if (requiredOptions.spinner) {
         startTimer();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "message-await",
-    "version": "0.2.0",
+    "version": "0.4.0",
     "description": "A utility to print message with an async success or failure in node.js",
     "main": "dist/src/index.js",
     "scripts": {
@@ -26,20 +26,20 @@
         "log-symbols": "^4.1.0"
     },
     "devDependencies": {
-        "@types/node": "^14.17.1",
-        "@typescript-eslint/eslint-plugin": "^4.20.0",
-        "@typescript-eslint/parser": "^4.20.0",
-        "chalk": "^4.1.1",
+        "@types/node": "^14.17.9",
+        "@typescript-eslint/eslint-plugin": "^4.29.0",
+        "@typescript-eslint/parser": "^4.29.0",
+        "chalk": "^4.1.2",
         "concurrently": "^6.2.0",
-        "eslint": "^7.19.0",
+        "eslint": "^7.32.0",
         "eslint-config-prettier": "^7.2.0",
-        "eslint-config-standard": "^16.0.2",
-        "eslint-plugin-import": "^2.22.1",
+        "eslint-config-standard": "^16.0.3",
+        "eslint-plugin-import": "^2.23.4",
         "eslint-plugin-node": "^11.1.0",
-        "eslint-plugin-prettier": "^3.3.1",
-        "eslint-plugin-promise": "^4.2.1",
-        "prettier": "^2.2.1",
+        "eslint-plugin-prettier": "^3.4.0",
+        "eslint-plugin-promise": "^4.3.1",
+        "prettier": "^2.3.2",
         "rimraf": "^3.0.2",
-        "typescript": "^4.1.5"
+        "typescript": "^4.3.5"
     }
 }