Log Process Errors Versions Save

Show some ❤️ to Node.js process errors

12.0.0

6 months ago

Breaking changes

  • Minimal supported Node.js version is now 18.18.0

11.0.1

11 months ago

Dependencies

  • Upgrade internal dependencies

11.0.0

11 months ago

Breaking changes

  • Minimal supported Node.js version is now 16.17.0

10.2.0

1 year ago

Features

  • Improve tree-shaking support

10.1.1

1 year ago

Internal

  • Add more tests

10.1.0

1 year ago

Features

10.0.0

1 year ago

Package size

The npm package size has been reduced by 98%, from 4500kB to 87kB.

Custom logic

The log option was renamed to onError. Its arguments are (originalError, event) instead of (error, level, originalError).

The process error event is now passed as a second argument instead of being set as error.name. Its case is not capitalized anymore, to match the event name in Node.js.

Before:

logProcessErrors({
  log(error) {
    if (error.name === 'UncaughtException') {
      console.error(error)
    }
  },
})

After:

logProcessErrors({
  onError(error, event) {
    if (event === 'uncaughtException') {
      console.error(error)
    }
  },
})

Pretty-printing

Errors are not pretty-printed anymore. As a consequence, the colors option was removed too. The onError option can be used instead to customize how the errors are printed.

Filtering

The levels option was removed. The onError option can be used for filtering.

Before:

logProcessErrors({
  levels: {
    warning: 'silent',
  },
})

After:

logProcessErrors({
  onError(error, event) {
    if (event !== 'warning') {
      console.error(error)
    }
  },
})

Testing option

The testing option was removed. The onError option can be used instead.

Before:

logProcessErrors({ testing: 'ava' })

After:

logProcessErrors({
  // Throw the `error` to make the unit test fail while letting other tests run
  onError(error) {
    throw error
  },
})

Process exit

The exitOn option was changed from an array of strings to a simpler boolean. It was also renamed exit.

The exit is still graceful, i.e. it waits for ongoing tasks to complete, up to 3 seconds. However, if there are none, the process now exits immediately.

Before:

logProcessErrors({ exitOn: [] })

After:

logProcessErrors({ exit: false })

Compatibility with other libraries

If other libraries (such as Winston, Bugsnag, etc.) are also listening for process events, they might also try to exit the process. This created conflicts with this library. This has been fixed by making the exit option default to false when process events listeners already exist.

Bug fixes

  • Fix support for --unhandled-rejections=strict
  • Do not crash when error.stack is undefined or null
  • Support cross-realm errors

TypeScript

TypeScript types have been simplified.

Internal

Added 100% test coverage.

9.4.0

1 year ago

Features

  • Reduce npm package size

9.3.0

1 year ago

Documentation

9.2.0

1 year ago

Features

  • Reduce npm package size