message-await
v1.1.0
Published
A utility to print message with an async success or failure in node.js
Downloads
1,380
Readme
message-await
A utility to print message with an async success or failure in node.js
Installation
npm install message-await
Why Use This?
It's a really simple way of giving your user feedback that we are waiting for something and then to give feedback on success or failure:
Usage
import print from 'message-await';
const messageAwait = print('Loading the thing', true, chalk.blue);
await someAsyncProcess;
messageAwait.success('The thing loaded');
Examples
Success or Failure
import print from 'message-await';
const messageAwait = print('Loading the thing', true, chalk.blue);
await someAsyncProcess;
messageAwait.success("optional complete message");
// OR: messageAwait.fail("optional fail message");
// OR: messageAwait.complete(true, "optional message")
// OR: messageAwait.complete(false)
Progress
import print from '../src';
import chalk from 'chalk';
const messageAwait = print('Loading', true, chalk.blue);
function onProgressCallback(complete: number, total: number){
messageAwait.updateMessage(`Loading ${complete}/${total}`);
}
function onCompleteCallback(total: number){
messageAwait.success(`Loading ${complete}/${total}`);
}
someAsyncFunction(onProgressCallback, onCompleteCallback);
Await
const result = await print('Waiting', true, chalk.blue).await(examplePromise, true, true, 'Done', 'Fail');
Success
Fail
The above example exits the process and prints the error message when the promise is rejected: