Properly wrap an error's message.
Features
Example
import wrapErrorMessage from 'wrap-error-message'
wrapErrorMessage(new Error('Message.'), 'Additional message.')
wrapErrorMessage(new Error('Message.'), 'Additional message:')
wrapErrorMessage(new Error('Message.'), 'Additional message:\n')
wrapErrorMessage(new Error('Message.'), '')
const invalidError = 'Message.'
wrapErrorMessage(invalidError, 'Additional message.')
wrapErrorMessage(new Error(' Message with spaces '), ' Additional message ')
Install
npm install wrap-error-message
This package works in both Node.js >=14.18.0 and
browsers.
It is an ES module and must be loaded using
an import
or import()
statement,
not require()
.
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
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!