@tomjs/electron-devtools-installer/dist/index.d.ts

import { Session } from 'electron';

/**
 * Download extension options
 */
interface DownloadOptions {
    /**
     * Force to download the extension even if it's already installed. Default is `false`
     * @default false
     */
    force?: boolean;
    /**
     * Whether to unzip the downloaded file. Default is `true`
     * @default true
     */
    unzip?: boolean;
    /**
     * Number of attempts to download the extension. Default is `5`
     * @default 5
     */
    attempts?: number;
    /**
     * The path to save the extension. Default is `path.join(app.getPath('userData'), 'extensions')`
     * @default path.join(app.getPath('userData'), 'extensions')
     */
    outPath?: string;
    /**
     * Download source. When the OS language is `zh_CN` , the default value is `npmmirror`, otherwise it is `chrome`.
     * @see https://www.npmjs.com/package/@tomjs/electron-devtools-files
     * @default "chrome"
     */
    source?: 'chrome' | 'unpkg' | 'jsdelivr' | 'npmmirror';
}
/**
 * download file from network
 * @param url url address to download
 * @param filePath file path to save
 * @returns
 */
declare const downloadFile: (url: string, filePath: string) => Promise<void>;
/**
 * download chrome extension
 * @param extensionId extension id
 * @param options download extension options
 */
declare function downloadExtension(extensionId: string, options?: DownloadOptions): Promise<{
    filePath: string;
    unzipPath?: string;
}>;

/**
 * Angular DevTools
 * @see https://chromewebstore.google.com/detail/ienfalfjdbdpebioblfackkekamfmbnh
 */
declare const ANGULAR_DEVTOOLS = "ienfalfjdbdpebioblfackkekamfmbnh";
/**
 * Apollo Client Devtools
 * @see https://chromewebstore.google.com/detail/jdkknkkbebbapilgoeccciglkfbmbnfm
 */
declare const APOLLO_CLIENT_TOOLS = "jdkknkkbebbapilgoeccciglkfbmbnfm";
/**
 * Backbone Debugger
 * @see https://chromewebstore.google.com/detail/bhljhndlimiafopmmhjlgfpnnchjjbhd
 */
declare const BACKBONE_DEBUGGER = "bhljhndlimiafopmmhjlgfpnnchjjbhd";
/**
 * Ember Inspector
 * @see https://chromewebstore.google.com/detail/bmdblncegkenkacieihfhpjfppoconhi
 */
declare const EMBER_INSPECTOR = "bmdblncegkenkacieihfhpjfppoconhi";
/**
 * jQuery Debugger
 * @see https://chromewebstore.google.com/detail/dbhhnnnpaeobfddmlalhnehgclcmjimi
 */
declare const JQUERY_DEBUGGER = "dbhhnnnpaeobfddmlalhnehgclcmjimi";
/**
 * MobX Developer Tools
 * @see https://chromewebstore.google.com/detail/pfgnfdagidkfgccljigdamigbcnndkod
 */
declare const MOBX_DEVTOOLS = "pfgnfdagidkfgccljigdamigbcnndkod";
/**
 * React Developer Tools
 * @see https://chromewebstore.google.com/detail/fmkadmapgofadopljbjfkapdkoienihi
 */
declare const REACT_DEVELOPER_TOOLS = "fmkadmapgofadopljbjfkapdkoienihi";
/**
 * Redux Devtools
 * @see https://chromewebstore.google.com/detail/lmhkpmbekcpmknklioeibfkpmmfibljd
 */
declare const REDUX_DEVTOOLS = "lmhkpmbekcpmknklioeibfkpmmfibljd";
/**
 * Vue.js devtools
 * @see https://chromewebstore.google.com/detail/nhdogjmejiglipccpnnnanhbledajbpd
 */
declare const VUEJS_DEVTOOLS = "nhdogjmejiglipccpnnnanhbledajbpd";
/**
 * All supported extensions
 */
declare const EXTENSIONS: string[];

/**
 * Install extension options.
 */
interface InstallOptions {
    /**
     * Force to download the extension even if it's already installed. Default is `false`.
     * @default false
     */
    forceDownload?: boolean;
    /**
     * Options for loading an unpacked extension.
     * @see https://www.electronjs.org/docs/latest/api/session#sesloadextensionpath-options
     */
    loadExtensionOptions?: Electron.LoadExtensionOptions;
    /**
     * Download url source. When the OS language is `zh_CN` , the default value is `npmmirror`, otherwise it is `chrome`.
     * @see https://www.npmjs.com/package/@tomjs/electron-devtools-files
     * @default "chrome"
     */
    source?: 'chrome' | 'unpkg' | 'jsdelivr' | 'npmmirror';
    /**
     * The target session on which the extension shall be installed, default is `session.defaultSession`.
     */
    session?: string | Session;
}
/**
 * Install Chrome extension for Electron
 * @param extensionIds Extension id or ids
 * @param options Install options
 */
declare function installExtension(extensionIds: string, options?: InstallOptions): Promise<Electron.Extension>;
declare function installExtension(extensionIds: string[], options?: InstallOptions): Promise<Electron.Extension[]>;

export { ANGULAR_DEVTOOLS, APOLLO_CLIENT_TOOLS, BACKBONE_DEBUGGER, EMBER_INSPECTOR, EXTENSIONS, type InstallOptions, JQUERY_DEBUGGER, MOBX_DEVTOOLS, REACT_DEVELOPER_TOOLS, REDUX_DEVTOOLS, VUEJS_DEVTOOLS, installExtension as default, downloadExtension, downloadFile, installExtension };