electron-types 45.0.0-alpha.3 → 45.0.0-alpha.5

package/README.md

@@ -14,11 +14,11 @@ The official `electron` package is ~200MB because it includes the Electron binar
 Since this package only provides TypeScript types, install it as a dev dependency. **Install the version that matches your Electron version** (see [Version Matching](#version-matching)):
 
 ```bash
-npm install -D electron-types@45.0.0-alpha.3
+npm install -D electron-types@45.0.0-alpha.5
 # or
-yarn add -D electron-types@45.0.0-alpha.3
+yarn add -D electron-types@45.0.0-alpha.5
 # or
-pnpm add -D electron-types@45.0.0-alpha.3
+pnpm add -D electron-types@45.0.0-alpha.5
 ```
 
 ## Usage

package/dist/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 45.0.0-alpha.3
+// Type definitions for Electron 45.0.0-alpha.5
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/typescript-definitions
@@ -1220,6 +1220,12 @@ declare namespace Electron {
     /**
      * Array of `ProcessMetric` objects that correspond to memory and CPU usage
      * statistics of all the processes associated with the app.
+     *
+     * > [!NOTE] `cpu.percentCPUUsage` and `cpu.idleWakeupsPerSecond` are averages over
+     * the time since the last call to `app.getAppMetrics()`, and each call starts a
+     * new measurement interval for every process at once. Other code in the main
+     * process, including dependencies, shares those intervals. See `CPUUsage` for more
+     * details.
      */
     getAppMetrics(): ProcessMetric[];
     /**
@@ -7196,36 +7202,6 @@ declare namespace Electron {
 
     // Docs: https://electronjs.org/docs/api/content-tracing
 
-    /**
-     * Resolves once heap profiling has been enabled.
-     *
-     * Enable heap profiling for MemoryInfra traces. Equivalent to the `--memlog`
-     * switch in Chrome.
-     *
-     * Only takes effect if the `disabled-by-default-memory-infra` category is
-     * included.
-     *
-     * Needs to be called before `contentTracing.startRecording()`.
-     *
-     * Usage:
-     *
-     * To view the recorded heap dumps:
-     *
-     * * Download the breakpad symbols for your Electron version from the Electron
-     * GitHub releases
-     * * Clone the Electron source code
-     * * In your Chromium checkout for Electron, run this command to symbolicate the
-     * heap dump:
-     * * Open the symbolicated trace in `chrome://tracing` (the Perfetto UI does not
-     * support memory dumps yet)
-     * * Click on one of the `M` symbols
-     * * Click on a `☰` triple bar icon (e.g., in the `malloc` column)
-     *
-     * [Image: Screenshot showing how to view a heapdump in Chromium's tracing view]
-     *
-     * @experimental
-     */
-    enableHeapProfiling(options?: EnableHeapProfilingOptions): Promise<void>;
     /**
      * resolves with an array of category groups once all child processes have
      * acknowledged the `getCategories` request
@@ -7460,12 +7436,14 @@ declare namespace Electron {
      */
     cumulativeCPUUsage?: number;
     /**
-     * The number of average idle CPU wakeups per second since the last call to
-     * getCPUUsage. First call returns 0. Will always return 0 on Windows.
+     * The number of average idle CPU wakeups per second since the last call to the API
+     * that returned this object. First call returns 0. Will always return 0 on
+     * Windows.
      */
     idleWakeupsPerSecond: number;
     /**
-     * Percentage of CPU used since the last call to getCPUUsage. First call returns 0.
+     * Percentage of CPU used since the last call to the API that returned this object.
+     * First call returns 0.
      */
     percentCPUUsage: number;
   }
@@ -7707,6 +7685,14 @@ declare namespace Electron {
      * indicating the failure of the command.
      *
      * Send given command to the debugging target.
+     *
+     * > [!NOTE]
+     *
+     * * If `sendCommand` is called before the target has navigated (e.g. immediately
+     * after `attach()`), the returned promise may not resolve until navigation occurs.
+     * * If the command's response has no `result` data, as defined by that command's
+     * entry in the remote debugging protocol, the promise resolves with an empty
+     * object (`{}`), not `null` or `undefined`.
      */
     sendCommand(method: string, commandParams?: any, sessionId?: string): Promise<any>;
   }
@@ -8411,32 +8397,6 @@ declare namespace Electron {
     savePath: string;
   }
 
-  interface EnableHeapProfilingOptions {
-
-    // Docs: https://electronjs.org/docs/api/structures/enable-heap-profiling-options
-
-    /**
-     * Controls which processes are profiled. Equivalent to `--memlog` in Chrome.
-     * Default is `all`.
-     */
-    mode?: ('all' | 'browser' | 'gpu' | 'minimal' | 'renderer-sampling' | 'all-renderers' | 'utility-sampling' | 'all-utilities' | 'utility-and-browser');
-    /**
-     * Controls the sampling interval in bytes. The lower the interval, the more
-     * precise the profile is. However it comes at the cost of performance. Default is
-     * `100000` (100KB). That is enough to observe allocation sites that make
-     * allocations >500KB total, where total equals to a single allocation size times
-     * the number of such allocations at the same call site. Equivalent to
-     * `--memlog-sampling-rate` in Chrome. Must be an integer between `1000` and
-     * `10000000`.
-     */
-    samplingRate?: number;
-    /**
-     * Controls the type of metadata recorded for each allocation. Equivalent to
-     * `--memlog-stack-mode` in Chrome. Default is `native`.
-     */
-    stackMode?: ('native' | 'native-with-thread-names');
-  }
-
   interface Extension {
 
     // Docs: https://electronjs.org/docs/api/structures/extension
@@ -9860,6 +9820,9 @@ declare namespace Electron {
      * This property can be dynamically changed; setting it to `undefined` removes the
      * badge. Only available on macOS 14 and up.
      *
+     * Badges are not displayed in Dock menus, though the same item shows its badge in
+     * an application menu.
+     *
      * @platform darwin
      */
     badge?: MenuItemBadge;
@@ -11614,7 +11577,8 @@ declare namespace Electron {
     // Docs: https://electronjs.org/docs/api/structures/process-metric
 
     /**
-     * CPU usage of the process.
+     * CPU usage of the process. Its `percentCPUUsage` and `idleWakeupsPerSecond` are
+     * averages over the time since the previous call to the API returning this object.
      */
     cpu: CPUUsage;
     /**
@@ -13671,8 +13635,12 @@ declare namespace Electron {
      * is available and `useSystemPicker` is set to `true`, the handler will not be
      * invoked.
      *
-     * Passing a WebFrameMain object as a video or audio stream will capture the video
-     * or audio stream from that frame.
+     * Passing a WebFrameMain object as a video or audio stream captures the whole
+     * `webContents` that contains that frame (the tab), not just the frame:
+     * `request.frame` from an `<iframe>` therefore grants that iframe a capture of the
+     * page that embeds it. Check `request.frame` before using it this way, and note
+     * that the callback throws if the frame has been destroyed by the time it is
+     * called.
      *
      * Passing `null` instead of a function resets the handler to its default state.
      */
@@ -22199,6 +22167,15 @@ declare namespace Electron {
      * The blocked path attempting to be accessed.
      */
     path: string;
+    /**
+     * The frame that initiated access. May be `null` if the frame has since been
+     * destroyed.
+     */
+    frame: (WebFrameMain) | (null);
+    /**
+     * The WebContents that contains `frame`.
+     */
+    webContents: (WebContents) | (null);
   }
 
   interface FindInPageOptions {
@@ -22789,6 +22766,7 @@ declare namespace Electron {
     /**
      * A badge shown alongside the label, either a system-styled count (`alerts`,
      * `updates`, `new-items`) or a custom string. Only available on macOS 14 and up.
+     * Not displayed in Dock menus.
      *
      * @platform darwin
      */
@@ -23574,7 +23552,8 @@ declare namespace Electron {
      */
     embeddingOrigin?: string;
     /**
-     * The security origin of the `media` check.
+     * The origin of the requesting frame, for `media`, `hid`, `usb` and `serial`
+     * checks.
      */
     securityOrigin?: string;
     /**
@@ -23582,8 +23561,8 @@ declare namespace Electron {
      */
     mediaType?: ('video' | 'audio' | 'unknown');
     /**
-     * The last URL the requesting frame loaded.  This is not provided for cross-origin
-     * sub frames making permission checks.
+     * The last URL the requesting frame loaded. Not provided when the check is not
+     * made on behalf of a document (for example for a service worker).
      */
     requestingUrl?: string;
     /**
@@ -24216,7 +24195,8 @@ declare namespace Electron {
     /**
      * If a string is specified, can be `loopback` or `loopbackWithMute`. Specifying a
      * loopback device will capture system audio, and is currently only supported on
-     * Windows. If a WebFrameMain is specified, will capture audio from that frame.
+     * Windows. If a WebFrameMain is specified, will capture audio from the
+     * `webContents` that contains that frame.
      */
     audio?: (('loopback' | 'loopbackWithMute')) | (WebFrameMain);
     /**
@@ -25750,7 +25730,6 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
-    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -26175,7 +26154,6 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
-    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -26524,7 +26502,6 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
-    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -26875,7 +26852,6 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
-    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -27322,7 +27298,6 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
-    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -27539,6 +27514,14 @@ declare namespace NodeJS {
      * Kilobytes.
      */
     getBlinkMemoryInfo(): Electron.BlinkMemoryInfo;
+    /**
+     * CPU usage of the process this is called in.
+     * 
+     * > [!NOTE] `percentCPUUsage` and `idleWakeupsPerSecond` are averages over the
+     * time since the previous call to `process.getCPUUsage()` in this process, and
+     * each call starts a new measurement interval. Every caller in the process shares
+     * that interval. See `CPUUsage` for details.
+     */
     getCPUUsage(): Electron.CPUUsage;
     /**
      * The number of milliseconds since epoch, or `null` if the information is

package/dist/version.json

@@ -1,4 +1,4 @@
 {
-  "electronVersion": "45.0.0-alpha.3",
-  "extractedAt": "2026-09-01T02:20:02.877Z"
+  "electronVersion": "45.0.0-alpha.5",
+  "extractedAt": "2026-09-08T00:36:11.734Z"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-types",
-  "version": "45.0.0-alpha.3",
+  "version": "45.0.0-alpha.5",
   "type": "module",
   "description": "TypeScript type definitions extracted from the electron package",
   "types": "./dist/electron.d.ts",