How do I integrate electron-unhandled with Sentry for error tracking?

Pass a custom logger function to the options that uses Sentry.captureException to send errors. For instance, define logger as (error) => Sentry.captureException(error) to seamlessly log errors to your Sentry dashboard, as suggested in the logger option description.

Is electron-unhandled better than Electron's built-in error handling?

Yes, electron-unhandled provides more robust coverage by catching errors across both processes and offering configurable dialogs, whereas Electron's built-in handling is basic and may not prevent silent crashes or improve user experience in production.

Can I customize the error dialog's appearance in electron-unhandled?

Customization is limited to the title via the options; the dialog design is fixed as shown in the screenshot. For fully custom UIs, you'd need to bypass the dialog feature or use additional libraries, which adds complexity.

What's the minimum setup needed for electron-unhandled to work?

Simply call unhandled() in the main process—it's required at minimum. For full coverage, also call it in renderer processes. No extra configuration is needed for basic error catching and production dialogs, as per the usage example.

Does electron-unhandled handle errors in promise rejections?

Yes, it catches unhandled promise rejections in both main and renderer processes, helping prevent crashes from asynchronous code errors, which is a key feature highlighted in the description and usage.

How to disable the error dialog in development mode?

The showDialog option defaults to production only if using electron-is-dev. You can manually set showDialog to false in the options to disable it in any environment, but this requires explicit configuration override.

Open-Awesome

electron-unhandled

MITJavaScriptv5.0.0

Catch unhandled errors and promise rejections in Electron apps with customizable logging and error dialogs.

GitHub

465 stars27 forks0 contributors

What is electron-unhandled?

electron-unhandled is a lightweight Node.js module designed specifically for Electron applications. It catches unhandled errors and promise rejections that would otherwise cause silent crashes or unexpected behavior. The module provides configurable error logging and can display user-friendly error dialogs in production environments.

Target Audience

Electron developers building desktop applications who need reliable error handling across both main and renderer processes. It's particularly useful for teams wanting to improve application stability and user experience.

Value Proposition

Developers choose electron-unhandled because it's specifically designed for Electron's multi-process architecture, requires minimal configuration, and provides production-ready error dialogs with optional GitHub issue reporting integration.

Overview

Catch unhandled errors and promise rejections in your Electron app

Use Cases

Best For

Adding basic error handling to new Electron applications
Preventing silent crashes in production Electron apps
Integrating error reporting with services like Sentry
Creating user-friendly error dialogs with reporting capabilities
Handling promise rejections across Electron processes
Standardizing error logging in multi-window Electron apps

Not Ideal For

Projects using Electron versions below 30
Applications with existing, comprehensive error monitoring systems like Sentry fully configured
Developers who require highly customized error UI or handling logic beyond basic dialogs and logging

Pros & Cons

Pros

Cross-Process Error Handling

Catches unhandled errors and promise rejections in both main and renderer processes, as emphasized in the usage notes, ensuring no error slips through the cracks in Electron's multi-process architecture.

Production-Ready Dialogs

Automatically presents user-friendly error dialogs in production environments, with an optional report button for GitHub issue creation, as shown in the screenshot and example code, improving UX without extra work.

Extensible Logging

Allows integration with external services like Sentry through a customizable logger function in the options, making it easy to add advanced error tracking with minimal configuration.

Manual Error Logging

Provides a logError function for manually logging caught errors with consistent formatting, ensuring uniformity in error reporting across the application, as detailed in the API section.

Cons

Electron Version Requirement

Requires Electron 30 or later, as stated in the README, which can exclude legacy projects or teams slow to upgrade, limiting adoption in older codebases.

Main Process Configuration Limitation

All options must be specified in the main process only, as noted in the API documentation, reducing flexibility for renderer-specific error handling setups and potentially complicating multi-window apps.

Basic Functionality

While effective for core error catching, it lacks advanced features such as error analytics, custom UI themes, or detailed error grouping, which might be needed for complex monitoring scenarios.

Frequently Asked Questions

Related Projects

rxdb

The local-first database that runs on every JS runtime and replicates with your existing backend - no vendor, no lock-in - https://rxdb.info/

Stars23,289

Forks1,169

Last commit22 hours ago

got

🌐 Human-friendly and powerful HTTP request library for Node.js

Stars14,927

Forks992

Last commit7 days ago

electron-builder

A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box

The JavaScript Database, for Node.js, nw.js, electron and the browser

Stars13,541

Forks1,011

Last commit1 year ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub