package
💣 Error handler for CLI applications 💥
npm install handle-cli-errorGitHub-flavored package documentation.
Across all versions, last 30 days.
66,017 in 30 days
Runtime metadata.
Tagged topics.
Error handler for CLI applications.
#!/usr/bin/env node
import handleCliError from 'handle-cli-error'
const cliMain = () => {
try {
// ...
} catch (error) {
handleCliError(error) // Logs `error` then exit the process
}
}
cliMain()handleCliError(error, {
classes: {
InputError: { exitCode: 1, stack: false },
DatabaseError: { exitCode: 2, stack: false },
default: { exitCode: 3 },
},
})npm install handle-cli-errorThis package works in Node.js >=18.18.0.
This is an ES module. It must be loaded using
an import or import() statement,
not require(). If TypeScript is used, it must be configured to
output ES modules,
not CommonJS.
error any
options Options?
Return value: undefined
Logs error on the console (stderr) then exits the process.
This never throws. Invalid errors are silently normalized.
Type: integer
Default: 1
Process exit code.
We recommend values between 1 and 124 because the following exit codes have some special meaning:
optionsType: boolean
Default: true
Whether to log the error's stack trace.
Type: boolean
Default: true
Whether to show nested errors, i.e.
error.cause
and
error.errors.
Type: boolean
Default: true
Whether to log the error's additional properties.
Type: boolean
Default: false
Exits the process without logging anything on the console.
Type: boolean
Default: true in terminals, false otherwise
Whether to colorize the error's message, stack trace and additional properties.
Quoted strings in the error's message are printed in bold (for "..." and
'...') and in italic (for `...`).
Type: string
Default: 'cross'
Icon prepended to the error's name. The available values are listed here. Can be disabled by passing an empty string.
Type: string
Default: 'red bold'
Color/style of the error's icon and name. The available values are listed here. Several styles can be specified by using spaces. Can be disabled by passing an empty string.
Type: integer (in milliseconds)
Default: 5000 (5 seconds)
The process exits gracefully: it waits for any ongoing tasks (callbacks,
promises, etc.) to complete, up to a specific timeout.
Special values:
0: Exits right away, without waiting for ongoing tasksNumber.POSITIVE_INFINITY: Waits for ongoing tasks forever, without timing
outType: (string) => void
Default: console.error
Function used to print the error message.
Type: object
Default: {}
Specify different options per error class. The object:
error.name,
or "default" (used if no error.name matches)Type: string | symbol
Default: beautiful
Name of a method to map the output. That method must take the output as a string argument, transform it then return it.
class ExampleError extends Error {
beautiful(output) {
return output.replaceAll('secret', '***')
}
}
const error = new ExampleError('Unknown value: secret')
handleCliError(error) // 'Unknown value: ***'modern-errors: Handle errors in
a simple, stable, consistent waymodern-errors-cli: Handle
errors in CLI modulesmodern-errors-beautiful:
Prettify errors messages and stackserror-custom-class: Create
one error classThe logo background was created by dgim-studio.
For any question, don't hesitate to submit an issue on GitHub.
Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!
error-class-utilserror-serializer: Convert
errors to/from plain objectsnormalize-exception:
Normalize exceptions/errorsis-error-instance: Check if
a value is an Error instancemerge-error-cause: Merge an
error with its causeset-error-class: Properly
update an error's classset-error-message: Properly
update an error's messagewrap-error-message:
Properly wrap an error's messageset-error-props: Properly
update an error's propertiesset-error-stack: Properly
update an error's stackerror-cause-polyfill:
Polyfill error.causebeautiful-error: Prettify
error messages and stackslog-process-errors: Show
some ❤ to Node.js process errorserror-http-response:
Create HTTP error responseswinston-error-format: Log
errors with WinstonEstimated unpacked size across 10 packages.
152.6 kB
Includes dependencies.
4 direct dependencies.
^6.1.0
6.1.0
^4.1.0
4.1.0
^2.2.0
2.2.0
^4.0.1
4.0.1