ahmadawaisnode-cli-handle-error
Custom error handler for Node CLIs
Install
npm install node-cli-handle-error
Usage
const handleError = require('node-cli-handle-error');
// Let's say we get an error message from a custom command.
const [err, res] = await somePromise();
// Use the function. It will print the error and exit if there is an error.
handleError(`Failed while building on step #1`, err);
API
handleError(heading, err, displayError?, exit?)
❯ heading
Type: string
Heading of the error message.
❯ err
Type: error/object
❯ displayError
Type: boolean
Default: true (optional)
Display the error message or not.
❯ exit
Type: boolean
Default: true (optional)
Exit the CLI on error or not?
Changelog
KEY: 📦 NEW, 👌 IMPROVE, 🐛 FIX, 📖 DOC, 🚀 RELEASE, and ✅ TEST
I use Emoji-log, you should try it and simplify your git commits.
License & Conduct
- MIT © Ahmad Awais
- Code of Conduct
Connect
(follow) To stay up to date on free & open-source software
(follow) To get #OneDevMinute daily hot tips & trolls
(subscribe) To tech talks & #OneDevMinute videos
(read) In-depth & long form technical articles
(connect) On the LinkedIn profile y'all
Sponsor
Me (Ahmad Awais) and my incredible wife (Maedah Batool) are two engineers who fell in love with open source and then with each other. You can read more about me here. If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.
- 🌟 $9.99/month (recommended) ❯ Two cups of Caffè latte (coffee) every month →
- 🚀 $99.99 (one-time sponsor) ❯ Support an hour of open-source code →
- 🔰 $49.99 (one-time sponsor) ❯ Support an hour of maintenance →
- ☕️ $9.99 (one-time sponsor) ❯ Lunch/coffee →
Or you can back me by checking out my super fun video course. As developers, we spend over 200 Hrs/month with our code editors — it's only fair to learn your next editor deeply. This course will save you 15-20 hours every month. Become a VSCode Power User →
