Properly wrap an error's message.

Features

- Handle
invalid errors
- Update error.stack with the
new error message
- Either append or prepend the new message
- Trim whitespaces

Example

``js
import wrapErrorMessage from 'wrap-error-message'

wrapErrorMessage(new Error('Message.'), 'Additional message.')
// Error: Message.
// Additional message.

wrapErrorMessage(new Error('Message.'), 'Additional message:')
// Error: Additional message: Message.

wrapErrorMessage(new Error('Message.'), 'Additional message:\n')
// Error: Additional message:
// Message.

wrapErrorMessage(new Error('Message.'), '')
// Error: Message.

const invalidError = 'Message.'
wrapErrorMessage(invalidError, 'Additional message.')
// Error: Message.
// Additional message.

wrapErrorMessage(new Error(' Message with spaces '), ' Additional message ')
// Error: Message with spaces
// Additional message
`

Install

`bash
npm install wrap-error-message
`

This package works in both Node.js >=18.18.0 and
browsers.

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.

API

wrapErrorMessage(error, message)

error Error | any\
message string\
_Return value_: Error

Appends message to error.message. If message ends with : or :\n,
prepends it instead.

Returns error. If error is not an Error instance, it is converted to one.

Related projects

- modern-errors: Handle errors in
a simple, stable, consistent way
- 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 instance
- merge-error-cause: Merge an
error with its cause
- set-error-class: Properly
update an error's class
- set-error-message: Properly
update an error's message
- set-error-props: Properly
update an error's properties
- set-error-stack: Properly
update an error's stack
- error-cause-polyfill:
Polyfill error.cause
- handle-cli-error: 💣 Error
handler for CLI applications 💥
- log-process-errors: Show
some ❤ to Node.js process errors
- error-http-response:
Create HTTP error responses
- winston-error-format: Log
errors with Winston

Support

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.

Contributing

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!