Package Health Score

57 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.17.2	\|	08/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.16.0	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.15.1	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.14.2	\|	06/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.13.1	\|	12/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (6,748)

Dependents: 55
GitHub Stars: 1.15K
Forks: 78
Contributors: 20

Direct Usage Popularity

The npm package electron-util receives a total of 6,748 downloads a week. As such, we scored electron-util popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package electron-util, we found that it has been starred 1,150 times, and that 55 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 20
Funding: Yes

With more than 10 contributors for the electron-util repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 8
Open PR: 1
Last Release: 1 year ago
Last Commit: 5 months ago

Further analysis of the maintenance status of electron-util based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for electron-util is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 2 Direct
Versions: 35
Install Size: 44.3 kB
Dist-tags: 1
# of Files: 11
Maintainers: 1
TS Typings: No

electron-util has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use electron-util?

To help you get started, we've collected the most common ways that electron-util is being used within popular public projects.

ooni / probe-desktop / main / utils / ooni / ooniprobe.js View on Github

return new Promise((resolve, reject) => {
      try {
        let binPath = self._binaryPath,
          options = {
            stdio: ['pipe', 'pipe', 'pipe'],
            env: {
              'OONI_HOME': getHomeDir(),
            }
          }
        if (is.windows) {
          const isAscii = /^[ -~]+$/
          let homeDir = os.homedir()
          try {
            // This is a workaround for the users home directory containing
            // non-ascii characters.
            // For more context see: https://github.com/nodejs/node/issues/17586
            if (!isAscii.test(homeDir)) {
              // eslint-disable-next-line no-console
              log.info('detected non-ascii characters in homeDir', homeDir)
              const shortHomeDir = GetHomeShortPath()
              options.env['OONI_HOME'] = path.join(shortHomeDir, path.relative(homeDir, options.env.OONI_HOME))
            }
          } catch (err) {
            // eslint-disable-next-line no-console
            console.log('failed to determine the home shortpath. Things will break with user homes which contain non-ascii characters.')
          }

View more ways to use electron-util

electron-util

Useful utilities for Electron apps and modules

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

Install

$ npm install electron-util

Requires Electron 5 or later.

Usage

const {is} = require('electron-util');

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

API

api

Type: object

Access the Electron APIs in both the main and renderer process without having to care about which one you're in.

For example, in the renderer process:

api.app.quit();

The app API is usually only available in the main process.

is

Type: object

Check for various things:

macos - Running on macOS
linux - Running on Linux
windows - Running on Windows
main - Running on the main process
renderer - Running on the renderer process
development - Running in development, not in production
usingAsar - The app is using ASAR
macAppStore - The app is an Mac App Store build
windowsStore - The app is a Windows Store AppX build

electronVersion

Type: string
Example: '1.7.9'

Electron version.

chromeVersion

Type: string
Example: '62.0.3202'

Chrome version in Electron.

platform(choices)

Type: Function

Accepts an object with the keys as either macos, windows, linux, or default, and picks the appropriate key depending on the current platform. If no platform key is matched, the default key is used if it exists. If the value is a function, it will be executed, and the returned value will be used.

init({
	enableUnicorn: util.platform({
		macos: true,
		windows: false,
		linux: () => false
	})
});

activeWindow()

Type: Function

Returns the active window.

runJS(code, window?)

Type: Function

Run some JavaScript in the active or given window.

Returns a promise for the result of the executed code or a rejected promise if the result is a rejected promise.

fixPathForAsarUnpack(path)

Type: Function

ASAR is great, but it has limitations when it comes to executing binaries. For example, child_process.spawn() is not automatically handled. So you would have to unpack the binary, for example, with the asarUnpack option in electron-builder. This creates a problem as the path to the binary changes, but your path.join(__dirname, 'binary') is not changed. To make it work you need to fix the path. That's the purpose of this method.

Before:

/Users/sindresorhus/Kap.app/Contents/Resources/app.asar/node_modules/foo/binary

After:

/Users/sindresorhus/Kap.app/Contents/Resources/app.asar.unpacked/node_modules/foo/binary

enforceMacOSAppLocation() ^macOS

Type: Function

On macOS, for security reasons, if an app is launched outside the Applications folder, it will run in a read-only disk image, which could cause subtle problems for your app. Use this method to ensure the app lives in the Applications folder.

It must not be used until the app.whenReady() promise is resolved.

It will be a no-op during development and on other systems than macOS.

It will offer to automatically move the app for the user:

menuBarHeight() ^macOS

Returns the height of the menu bar on macOS, or 0 if not macOS.

getWindowBoundsCentered(options?)

Get the bounds of a window as if it was centered on the screen.

options

Type: object

window

Type: BrowserWindow
Default: Current window

The window to get the bounds of.

size

Type: object
Default: Size of window

Set a new window size. Example: {width: 600, height: 400}

useFullBounds

Type: boolean
Default: false

Use the full display size when calculating the position. By default, only the workable screen area is used, which excludes the Windows taskbar and macOS dock.

centerWindow(options?)

Center a window on the screen.

options

Type: object

window

Type: BrowserWindow
Default: Current window

The window to center.

size

Type: object
Default: Size of window

Set a new window size. Example: {width: 600, height: 400}

animated

Type: boolean
Default: false

Animate the change.

useFullBounds

Type: boolean
Default: false

Use the full display size when calculating the position. By default, only the workable screen area is used, which excludes the Windows taskbar and macOS dock.

disableZoom(window?)

Disable zooming, usually caused by pinching the trackpad on macOS or Ctrl + on Windows.

window

Type: BrowserWindow
Default: Current window

appLaunchTimestamp

Type: number

A timestamp (Date.now()) of when your app launched.

isFirstAppLaunch()

Returns a boolean of whether it's the first time your app is launched.

It works by writing a file to app.getPath('userData') if it doesn't exist and checks that. That means it will return true the first time you add this check to your app.

darkMode

Requires Electron 7

Type: object

const {darkMode} = require('electron-util');

console.log(darkMode.isEnabled);
//=> false

darkMode.onChange(() => {
	console.log(darkMode.isEnabled);
	//=> true
});

isEnabled

Type: boolean

Whether the macOS dark mode is enabled.

On Windows and Linux, it's false.

onChange(callback)

The callback function is called when the macOS dark mode is toggled.

Returns a function, that when called, unsubscribes the listener.

Calling it on Window and Linux works, but it just returns a no-op function.

setContentSecurityPolicy(policy, options?)

Set a Content Security Policy for your app.

Don't forget to validate the policy after changes.

const {setContentSecurityPolicy} = require('electron-util');

setContentSecurityPolicy(`
	default-src 'none';
	script-src 'self';
	img-src 'self' data:;
	style-src 'self';
	font-src 'self';
	connect-src 'self' https://api.example.com;
	base-uri 'none';
	form-action 'none';
	frame-ancestors 'none';
`);

policy

Type: string

You can put rules on separate lines, but lines must end in a semicolon.

options

Type: object

session

Type: Session
Default: electron.session.defaultSession

The session to apply the policy to.

openNewGitHubIssue(options)

Opens the new issue view on the given GitHub repo in the browser. Optionally, with some fields like title and body prefilled. The options are passed to the new-github-issue-url package.

const {openNewGitHubIssue} = require('electron-util');

openNewGitHubIssue({
	user: 'sindresorhus',
	repo: 'playground',
	body: 'Hello'
});

openUrlMenuItem(options)

Accepts the same options as new MenuItem() in addition to a url option.

If you specify the click option, its handler will be called before the URL is opened.

Returns a MenuItemConstructorOptions that creates a menu item, which opens the given URL in the browser when clicked.

const {Menu} = require('electron');
const {openUrlMenuItem} = require('electron-util');

const menu = Menu.buildFromTemplate([
	{
		label: 'Help',
		submenu: [
			openUrlMenuItem({
				label: 'Website',
				url: 'https://sindresorhus.com'
			})
		]
	}
]);

Menu.setApplicationMenu(menu);

showAboutWindow(options)

Shows an 'About' window. On macOS and Linux, the native 'About' window is shown, and on Windows, a simple custom dialog is shown.

On macOS, the icon, text, title, and website options are ignored. For icon, it already defaults to the app icon. For title, you don't need it as the native about window doesn't have a title.

const {showAboutWindow} = require('electron-util');

showAboutWindow({
	icon: path.join(__dirname, 'static/Icon.png'),
	copyright: 'Copyright © Sindre Sorhus',
	text: 'Some more info.'
});

options

Type: object

icon ^Linux ^Windows

Type: string

An absolute path to the app icon.

copyright

Type: string

The copyright text.

text

Type: string

Some additional text if needed. Shown below copyright info.

website ^Linux

Type: string

The URL to the app's website.

title ^Linux ^Windows

Type: string
Default: 'About'

Customizable for localization. Used in the menu item label.

The app name is automatically appended at runtime.

aboutMenuItem(options) ^Linux ^Windows

Accepts the same options as .showAboutWindow().

Returns a MenuItemConstructorOptions that creates a menu item, which shows the about dialog when clicked.

const {Menu} = require('electron');
const {aboutMenuItem} = require('electron-util');

const menu = Menu.buildFromTemplate([
	{
		label: 'Help',
		submenu: [
			aboutMenuItem({
				icon: path.join(__dirname, 'static/Icon.png'),
				copyright: 'Copyright © Sindre Sorhus',
				text: 'Some more info.'
			})
		]
	}
]);

Menu.setApplicationMenu(menu);

debugInfo()

Returns a string with debug info suitable for inclusion in bug reports.

For example, use this in the body option of the .openNewGitHubIssue() method.

const {debugInfo} = require('electron-util');

console.log(debugInfo());
/*
AppName 2.21.0
Electron 3.0.6
darwin 18.2.0
Locale: en-US
*/

appMenu(menuItems?) ^macOS

Creating the app menu (the first menu) on macOS requires a lot of boilerplate. This method includes the default boilerplate and lets you add additional menu items in the correct place.

menuItems

Type: MenuItem[]

Menu items to add below the About App Name menu item.

Usually, you would add at least a Preferences… menu item:

const {Menu} = require('electron');
const {appMenu} = require('electron-util');

const menu = Menu.buildFromTemplate([
	appMenu([
		{
			label: 'Preferences…',
			accelerator: 'Command+,',
			click() {}
		}
	])
]);

Menu.setApplicationMenu(menu);

openSystemPreferences(pane?, section?): Promise ^macOS ^Windows

Type: Function

Open the System Preferences on macOS and Windows 10.

This method does nothing on Linux.

A list of available options can be found here.

On macOS, optionally provide a pane and section.

pane

Type: string

Which pane of the System Preferences to open.

const {openSystemPreferences} = require('electron-util');

openSystemPreferences('security');

section ^macOS

Type: string

Optional section within the pane.

const {openSystemPreferences} = require('electron-util');

openSystemPreferences('security', 'Firewall');

Node.js API

This is for non-Electron code that might be included in an Electron app. For example, if you want to add special support for Electron in a vanilla Node.js module.

const electronUtil = require('electron-util/node');

if (electronUtil.isElectron) {
	// Electron workaround
} else {
	// Normal code
}

isElectron

Type: boolean

Check if you're running in an Electron app.

electronVersion

Type: string
Example: '1.7.9'

Electron version. Returns 0.0.0 when not in an Electron app.

isUsingAsar

Type: boolean

Check if the Electron app you're running in is using ASAR.

fixPathForAsarUnpack(path)

Same as the above Electron version.

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

electron-util dependencies

electron-is-dev new-github-issue-url

electron-util development dependencies

ava electron mock-require tsd type-fest xo

FAQs

What is electron-util?

Useful utilities for Electron apps and modules. Visit Snyk Advisor to see a full health score report for electron-util, including popularity, security, maintenance & community analysis.

Is electron-util popular?

The npm package electron-util receives a total of 6,748 weekly downloads. As such, electron-util popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is electron-util well maintained?

We found indications that electron-util is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is electron-util safe to use?

The npm package electron-util was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 2 October-2022, at 01:39 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (6,748)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use electron-util?

electron-util

Install

Usage

API

Contents

api

is

electronVersion

chromeVersion

platform(choices)

activeWindow()

runJS(code, window?)

fixPathForAsarUnpack(path)

enforceMacOSAppLocation() macOS

menuBarHeight() macOS

getWindowBoundsCentered(options?)

options

window

size

useFullBounds

centerWindow(options?)

options

window

size

animated

useFullBounds

disableZoom(window?)

window

appLaunchTimestamp

isFirstAppLaunch()

darkMode

isEnabled

onChange(callback)

setContentSecurityPolicy(policy, options?)

policy

options

session

openNewGitHubIssue(options)

openUrlMenuItem(options)

showAboutWindow(options)

options

icon Linux Windows

copyright

text

website Linux

title Linux Windows

aboutMenuItem(options) Linux Windows

debugInfo()

appMenu(menuItems?) macOS

menuItems

openSystemPreferences(pane?, section?): Promise macOS Windows

pane

section macOS

Node.js API

isElectron

electronVersion

isUsingAsar

fixPathForAsarUnpack(path)

Related

electron-util dependencies

electron-util development dependencies

FAQs

What is electron-util?

Is electron-util popular?

Is electron-util well maintained?

Is electron-util safe to use?

Build a secure application checklist

Select a recommended open source package

enforceMacOSAppLocation() ^macOS

menuBarHeight() ^macOS

icon ^Linux ^Windows

website ^Linux

title ^Linux ^Windows

aboutMenuItem(options) ^Linux ^Windows

appMenu(menuItems?) ^macOS

openSystemPreferences(pane?, section?): Promise ^macOS ^Windows

section ^macOS