sindresorhus / electron-util

Useful utilities for Electron apps and modules

electron-util

Useful utilities for Electron apps and modules

You can use this package directly in both the main and renderer process.

There are three parts of this package, “shared”, “main”, and “node”. The “shared” part works in both the main or rendered process. The “main” part works only in the main process. The “node” part is for Node.js-only APIs (not Electron).

To use features from the “main” part in the renderer process, you will need to set up IPC channels.

Install

npm install electron-util

Note

Requires Electron 28 or later.

Usage

The “shared” API you can access directly:

import {is} from 'electron-util';

console.log(is.macos && is.main);
//=> true

For the “main” API, use the /main sub-export:

import {isDev} from 'electron-util/main';

console.log(isDev);
//=> false

API

Documentation (The service is broken)

Look at the types for now.

Related

• electron-store - Save and load data like user preferences, app state, cache, etc
• electron-debug - Adds useful debug features to your Electron app
• electron-context-menu - Context menu for your Electron app
• electron-dl - Simplified file downloads for your Electron app
• electron-unhandled - Catch unhandled errors and promise rejections in your Electron app