cli-handle-error
v4.4.2
Published
Custom error handler for Node.js CLIs.
Maintainers
ahmadawaisReadme
cli-handle-error
Custom error handler for Node CLIs
Install
npm install node-cli-handle-error
Usage
const handleError = require('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
