1.0.3 • Published 3 years ago

cli-error-handler v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

cli-error-handler

Error handler for nodeJs.

📟

Install

npm install cli-error-handler

⚙️

Usage

const handleError = require('cli-error-handler');

// 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?

Connect