💣 Prettify error messages and stacks 💥
npm install beautiful-error





Prettify error messages and stacks.
- 🖍️ Pretty colors, icons and header
- 💣 Error class-specific and custom handling
- ⛑️ Normalize invalid errors
- 🔕 Log verbosity: stack, nested errors,
properties
- 💥 Exception-safe

``js
import beautifulError from 'beautiful-error'
try {
// ...
} catch (error) {
const message = beautifulError(error)
console.error(message)
}
`
`js`
const message = beautifulError(error, {
InputError: { icon: 'warning', stack: false },
DatabaseError: { icon: 'info', stack: false },
default: { icon: 'cross' },
})
`bash`
npm install beautiful-error
This 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?\string
_Return value_:
Returns error as a prettified string.
This never throws. Invalid errors are silently
normalized.
#### 📕 stack
_Type_: boolean\true
_Default_:
Whether to show the error's stack trace.
#### cause
_Type_: boolean\true
_Default_:
Whether to show nested errors, i.e.
error.cause
and
error.errors.
#### 📢 props
_Type_: boolean\true
_Default_:
Whether to show the error's additional properties.
#### 🖍️ colors
_Type_: boolean\true
_Default_: 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 ... ).
#### ❌ icon
_Type_: string\'cross'
_Default_:
Icon prepended to the error's name. The available values are listed
here.
Can be disabled by passing an empty string.
#### 💄 header
_Type_: string\'red bold'
_Default_:
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.
#### 💣 classes
_Type_: object\{}
_Default_:
Specify different options per error class. The object:
- Keys are either the
error.name,
or "default" (used if no error.name matches)
- Values are options objects
#### 🪛 custom
_Type_: string | symbol\beautiful
_Default_:
Name of a method to map the output. That method must take the output as a string
argument, transform it then return it.
`js
class ExampleError extends Error {
beautiful(output) {
return output.replaceAll('secret', '*')
}
}
const error = new ExampleError('Unknown value: secret')
const message = beautifulError(error) // 'Unknown value: *'
`
- modern-errors: Handle errors in
a simple, stable, consistent way
- modern-errors-beautiful:
Prettify errors messages and stacks
- modern-errors-cli: Handle
errors in CLI modules
- error-custom-class: Create
one error class
- error-class-utils: Utilities
to properly create error classes
- error-serializer: Convert
errors to/from plain objects
- normalize-exception:
Normalize exceptions/errors
- is-error-instance: Check if
a value is an Error instancemerge-error-cause
- : Merge ancause
error with its set-error-class
- : Properlyset-error-message
update an error's class
- : Properlywrap-error-message
update an error's message
- :set-error-props
Properly wrap an error's message
- : Properlyset-error-stack
update an error's properties
- : Properlyerror-cause-polyfill
update an error's stack
- :error.cause
Polyfill handle-cli-error
- : 💣 Errorlog-process-errors
handler for CLI applications 💥
- : Showerror-http-response
some ❤ to Node.js process errors
- :winston-error-format
Create HTTP error responses
- : Log
errors with Winston
The 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!