electrom

Electrom is a resource management solution for Electron applications, which is convenient for performance management and friendly debugging of multiple windows.

Contributors

xudafeng	yantze	sriting	snapre

This project follows the git-contributor spec, auto updated at Tue May 03 2022 11:32:04 GMT+0800.

Installment

npm i electrom --save-dev

How to use

Please visit the demo code

• ./example/main.ts
• electron-modules/electron-windows/blob/master/app/electrom.js

// main process: import electrom
import {
  EVENT_DATA_CHANNEL_NAME,
  BROWSER_WINDOW_PRELOAD_PATH,
  Monitor,
} from 'electrom';

const monitor = new Monitor();
/**
 * Please set this script's path as `webPreferences.preload` of `BrowserWindow`.
 * {
 *   preload: BROWSER_WINDOW_PRELOAD_PATH
 * }
 */
mainWindow.webContents.on('dom-ready', () => {
  monitor.on(EVENT_DATA_CHANNEL_NAME, (data: any) => {
    mainWindow.webContents.send(EVENT_DATA_CHANNEL_NAME, data);
  });
  monitor.bindEventToWindow(mainWindow);
  monitor.start();
});

Perf Board

You can use the Perf-Board standalone in your front-end.

import React from 'react';
import PerfBoard from 'electrom/src/PerfBoard';

function() {
  return (
    <PerfBoard />
  );
}

TODO

• [ ] heapdump

License

The MIT License (MIT)