National Patience Month

    set-error-message
    TypeScript icon, indicating that this package has built-in type declarations

    1.6.0 • Public • Published

    Node Browsers TypeScript Codecov Minified size Mastodon Medium

    Properly update an error's message.

    In V8 (Chrome, Node.js, Deno, etc.), error.stack includes error.message. However, if error.message is modified, error.stack might not be updated and still contain the previous message.

    This library fixes it by setting error.message while updating error.stack accordingly. This works on any JavaScript engine.

    Example

    Without set-error-message:

    const error = new Error('one')
    console.log(error.message) // 'one'
    console.log(error.stack) // 'Error: one ...'
    
    error.message = 'two'
    console.log(error.message) // 'two'
    console.log(error.stack) // 'Error: one ...'

    With set-error-message:

    import setErrorMessage from 'set-error-message'
    
    const error = new Error('one')
    console.log(error.message) // 'one'
    console.log(error.stack) // 'Error: one ...'
    
    setErrorMessage(error, 'two')
    console.log(error.message) // 'two'
    console.log(error.stack) // 'Error: two ...'

    Install

    npm install set-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

    setErrorMessage(error, newMessage)

    error Error | any
    newMessage string
    Return value: Error

    Sets error.message = newMessage.

    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!

    Install

    npm i set-error-message

    DownloadsWeekly Downloads

    5,856

    Version

    1.6.0

    License

    MIT

    Unpacked Size

    11.1 kB

    Total Files

    7

    Last publish

    Collaborators

    • ehmicky