:mag: electron-search-devtools

Locate the developer tools for Electron.

:warning: Requirements

• Electron: v11.3.0 or greater is required.

:inbox_tray: Install

$ npm install electron-search-devtools --save-dev

:hammer_and_wrench: Usage

// `session` is required.
const { app, BrowserWindow, session } = require('electron');
// import this module:
const { searchDevtools } = require('electron-search-devtools');

const createWindow = () => {
  const mainWindow = new BrowserWindow();
  mainWindow.loadFile('index.html');
};

// `async/await` is required.
app.whenReady().then(async () => {
  /**
   *
   * You can choose from the following six arguments:
   * 'REACT', 'REDUX', 'VUE', 'VUE3', 'ANGULAR' or 'JQUERY'.
   *
   */
  const devtools = await searchDevtools('REACT');
  await session.defaultSession.loadExtension(devtools, {
    /**
     * If you want to use 'loadFile' instead of 'loadURL',
     * you'll need to set `allowFileAccess` to true.
     */
    allowFileAccess: true,
  });

  createWindow();
});

app.on('window-all-closed', () => app.quit());

:green_book: API

searchDevtools(devtoolsName, { options }) => Promise<string | void>

devtoolsName

Type: 'REACT' | 'REDUX' | 'VUE' | 'VUE3' | 'ANGULAR' | 'JQUERY' (required)

options

profile

• Type: string
• Default: 'Default'

browser

• Type: 'google-chrome' | 'chromium' | 'chromium-snap'
• Default: 'google-chrome'

If you are using Chromium on Linux, specify chromium or chromium-snap.

:clipboard: Types

Devtools: 'JQUERY' | 'ANGULAR' | 'VUE' | 'VUE3' | 'REACT' | 'REDUX';
Options: {
    profile?: string;
    browser?: 'google-chrome' | 'chromium' | 'chromium-snap';
}

searchDevtools: (arg: Devtools, options?: Options | undefined) => Promise<string | void>;

:classical_building: License

Copyright (c) 2021 sprout2000 and other contributors
MIT Licensed