Nineties Party Mix

    log-process-errors
    TypeScript icon, indicating that this package has built-in type declarations

    10.2.0 • Public • Published
    log-process-errors logo

    Node TypeScript Codecov Twitter Medium

    📰 Medium article.

    Show some ❤️ to Node.js process errors.

    This improves process errors: uncaught exceptions, unhandled promises, promises handled too late and warnings.

    Features

    Install

    Production code (e.g. a server) can install this either as a production or development dependency:

    npm install log-process-errors

    However, libraries should install this as a development dependency:

    npm install -D log-process-errors

    This is because logging is modified globally and libraries users might not expect this side-effect. Also, this might lead to conflicts between libraries.

    This package works in Node.js >=14.18.0. It is an ES module and must be loaded using an import or import() statement, not require().

    API

    logProcessErrors(options?)

    options object?
    Return value: () => void

    Start handling process errors.

    import logProcessErrors from 'log-process-errors'
    logProcessErrors(options)

    The return value restores Node.js default behavior.

    const restore = logProcessErrors(options)
    restore()

    Options

    exit

    Type: boolean

    Whether to exit the process on uncaught exceptions or unhandled promises.

    This is false by default if other libraries are listening to those events, so they can perform the exit instead. Otherwise, this is true.

    If some tasks are still ongoing, the exit waits for them to complete up to 3 seconds.

    onError

    Type: (error, event) => Promise<void> | void
    Default: console.error(error)

    Function called once per process error. Duplicate process errors are ignored.

    // Log process errors with Winston instead
    logProcessErrors({
      onError(error, event) {
        winstonLogger.error(error.stack)
      },
    })

    error

    Type: Error

    The process error. This is guaranteed to be a normalized error instance. A short description of the event is also appended to its message.

    event

    Type: Event

    Process event name among: 'uncaughtException', 'unhandledRejection', 'rejectionHandled', 'warning'.

    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!

    Thanks go to our wonderful contributors:


    ehmicky

    💻 🎨 🤔 📖

    Steven Vachon

    💬

    Hongarc

    📖 💻

    Andy Brenneke

    🐛

    Install

    npm i log-process-errors

    DownloadsWeekly Downloads

    88,238

    Version

    10.2.0

    License

    Apache-2.0

    Unpacked Size

    28.8 kB

    Total Files

    12

    Last publish

    Collaborators

    • ehmicky