electron-types 45.0.0-beta.3 → 45.0.0-beta.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-beta.3
+npm install -D electron-types@45.0.0-beta.5
 # or
-yarn add -D electron-types@45.0.0-beta.3
+yarn add -D electron-types@45.0.0-beta.5
 # or
-pnpm add -D electron-types@45.0.0-beta.3
+pnpm add -D electron-types@45.0.0-beta.5
 ```
 
 ## Usage

package/dist/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 45.0.0-beta.3
+// Type definitions for Electron 45.0.0-beta.5
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/typescript-definitions
@@ -1353,6 +1353,13 @@ declare namespace Electron {
      * to the npm modules spec. You should usually also specify a `productName` field,
      * which is your application's full capitalized name, and which will be preferred
      * over `name` by Electron.
+     *
+     * Electron uses the application's name to construct the default `userData`
+     * directory. On Windows, neither `productName` nor `name` should contain the
+     * following special characters, which cannot be used in directory or file names:
+     * `<`, `>`, `:`, `"`, `\`, `/`, `|`, `?`, `*`. Using these characters in the
+     * application's name can prevent Electron from creating the default `userData`
+     * directory and cause the application to crash on startup.
      */
     getName(): string;
     /**
@@ -1857,6 +1864,8 @@ declare namespace Electron {
     /**
      * Overrides the current application's name.
      *
+     * On Windows, avoid the reserved filename characters in `name`.
+     *
      * > [!NOTE] This function overrides the name used internally by Electron; it does
      * not affect the name that the OS uses.
      */
@@ -2044,6 +2053,9 @@ declare namespace Electron {
      * to the npm modules spec. You should usually also specify a `productName` field,
      * which is your application's full capitalized name, and which will be preferred
      * over `name` by Electron.
+     *
+     * On Windows, the application's name must not contain reserved filename
+     * characters, because it is used to construct the default `userData` directory.
      */
     name: string;
     /**
@@ -7267,7 +7279,10 @@ declare namespace Electron {
      * soon as they receive the EnableRecording request.
      *
      * If a recording is already running, the promise will be immediately resolved, as
-     * only one trace operation can be in progress at a time.
+     * only one trace operation can be in progress at a time. If
+     * `options.nativeHeapProfiling` is set while a recording is already running, the
+     * promise is rejected instead, since the already-running recording's options can't
+     * be changed to turn on heap profiling.
      */
     startRecording(options: (TraceConfig) | (TraceCategoriesAndOptions)): Promise<void>;
     /**
@@ -7285,6 +7300,12 @@ declare namespace Electron {
      * Trace data will be written into `resultFilePath`. If `resultFilePath` is empty
      * or not provided, trace data will be written to a temporary file, and the path
      * will be returned in the promise.
+     *
+     * Trace data is written in the Perfetto protobuf format.
+     *
+     * Heap profiling samples record instruction addresses and module build IDs rather
+     * than function names. To symbolize them, use the symbols published for the
+     * matching Electron release with Chromium's `symbolize_trace` tool.
      */
     stopRecording(resultFilePath?: string): Promise<string>;
   }
@@ -10142,6 +10163,25 @@ declare namespace Electron {
     wheelTicksY?: number;
   }
 
+  interface NativeHeapProfilerOptions {
+
+    // Docs: https://electronjs.org/docs/api/structures/native-heap-profiler-options
+
+    /**
+     * The interval in milliseconds at which samples are written to the trace. Each
+     * write is a full snapshot of every sampled allocation that is still live, so
+     * short intervals can fill the trace buffer quickly in long recordings. Defaults
+     * to `0`, which writes a single snapshot when tracing stops.
+     */
+    dumpInterval?: number;
+    /**
+     * The average number of bytes allocated between samples. Lower values give a more
+     * precise profile at a higher performance cost. Must be greater than `0`. Defaults
+     * to Chromium's default, currently `131072` (128 KiB).
+     */
+    samplingInterval?: number;
+  }
+
   class NativeImage {
 
     // Docs: https://electronjs.org/docs/api/native-image
@@ -10612,9 +10652,6 @@ declare namespace Electron {
 
     // Docs: https://electronjs.org/docs/api/notification
 
-    /**
-     * @platform darwin,win32
-     */
     on(event: 'action', listener: (details: Event<NotificationActionEventParams>,
                                    /**
                                     * @deprecated
@@ -10625,9 +10662,6 @@ declare namespace Electron {
                                     * @platform win32
                                     */
                                    selectionIndex: number) => void): this;
-    /**
-     * @platform darwin,win32
-     */
     off(event: 'action', listener: (details: Event<NotificationActionEventParams>,
                                    /**
                                     * @deprecated
@@ -10638,9 +10672,6 @@ declare namespace Electron {
                                     * @platform win32
                                     */
                                    selectionIndex: number) => void): this;
-    /**
-     * @platform darwin,win32
-     */
     once(event: 'action', listener: (details: Event<NotificationActionEventParams>,
                                    /**
                                     * @deprecated
@@ -10651,9 +10682,6 @@ declare namespace Electron {
                                     * @platform win32
                                     */
                                    selectionIndex: number) => void): this;
-    /**
-     * @platform darwin,win32
-     */
     addListener(event: 'action', listener: (details: Event<NotificationActionEventParams>,
                                    /**
                                     * @deprecated
@@ -10664,9 +10692,6 @@ declare namespace Electron {
                                     * @platform win32
                                     */
                                    selectionIndex: number) => void): this;
-    /**
-     * @platform darwin,win32
-     */
     removeListener(event: 'action', listener: (details: Event<NotificationActionEventParams>,
                                    /**
                                     * @deprecated
@@ -15197,6 +15222,17 @@ declare namespace Electron {
      * `-excluded_category1,-excluded_category2`.
      */
     categoryFilter: string;
+    /**
+     * **Electron extension; not part of Chromium's TraceCategoriesAndOptions schema.**
+     * Enables native (C/C++) heap allocation profiling for this recording. This is
+     * distinct from JavaScript heap profiling (see `contents.takeHeapSnapshot()`); it
+     * samples allocations made by Chromium and native modules. Unlike `TraceConfig`,
+     * this object has no `included_process_ids` field, so every traced process is
+     * profiled.
+     *
+     * @experimental
+     */
+    nativeHeapProfiling?: NativeHeapProfilerOptions;
     /**
      * Controls what kind of tracing is enabled, it is a comma-delimited sequence of
      * the following strings: `record-until-full`, `record-continuously`,
@@ -15249,6 +15285,17 @@ declare namespace Electron {
      * memory-infra docs for more information.
      */
     memory_dump_config?: Record<string, any>;
+    /**
+     * **Electron extension; not part of Chromium's TraceConfig schema.** Enables
+     * native (C/C++) heap allocation profiling for this recording. This is distinct
+     * from JavaScript heap profiling (see `process.takeHeapSnapshot()` or
+     * `contents.takeHeapSnapshot()`); it samples allocations made by Chromium and
+     * native modules. `included_process_ids` above also limits which processes are
+     * profiled when this is enabled.
+     *
+     * @experimental
+     */
+    nativeHeapProfiling?: NativeHeapProfilerOptions;
     /**
      * Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible`
      * or `trace-to-console`. Defaults to `record-until-full`.
@@ -23321,8 +23368,6 @@ declare namespace Electron {
     /**
      * Actions to add to the notification. Please read the available actions and
      * limitations in the `NotificationAction` documentation.
-     *
-     * @platform darwin,win32
      */
     actions?: NotificationAction[];
     /**
@@ -26060,6 +26105,7 @@ declare namespace Electron {
     type MimeTypedBuffer = Electron.MimeTypedBuffer;
     type MouseInputEvent = Electron.MouseInputEvent;
     type MouseWheelInputEvent = Electron.MouseWheelInputEvent;
+    type NativeHeapProfilerOptions = Electron.NativeHeapProfilerOptions;
     type NavigationEntry = Electron.NavigationEntry;
     type NotificationAction = Electron.NotificationAction;
     type NotificationResponse = Electron.NotificationResponse;
@@ -26488,6 +26534,7 @@ declare namespace Electron {
     type MimeTypedBuffer = Electron.MimeTypedBuffer;
     type MouseInputEvent = Electron.MouseInputEvent;
     type MouseWheelInputEvent = Electron.MouseWheelInputEvent;
+    type NativeHeapProfilerOptions = Electron.NativeHeapProfilerOptions;
     type NavigationEntry = Electron.NavigationEntry;
     type NotificationAction = Electron.NotificationAction;
     type NotificationResponse = Electron.NotificationResponse;
@@ -26840,6 +26887,7 @@ declare namespace Electron {
     type MimeTypedBuffer = Electron.MimeTypedBuffer;
     type MouseInputEvent = Electron.MouseInputEvent;
     type MouseWheelInputEvent = Electron.MouseWheelInputEvent;
+    type NativeHeapProfilerOptions = Electron.NativeHeapProfilerOptions;
     type NavigationEntry = Electron.NavigationEntry;
     type NotificationAction = Electron.NotificationAction;
     type NotificationResponse = Electron.NotificationResponse;
@@ -27194,6 +27242,7 @@ declare namespace Electron {
     type MimeTypedBuffer = Electron.MimeTypedBuffer;
     type MouseInputEvent = Electron.MouseInputEvent;
     type MouseWheelInputEvent = Electron.MouseWheelInputEvent;
+    type NativeHeapProfilerOptions = Electron.NativeHeapProfilerOptions;
     type NavigationEntry = Electron.NavigationEntry;
     type NotificationAction = Electron.NotificationAction;
     type NotificationResponse = Electron.NotificationResponse;
@@ -27644,6 +27693,7 @@ declare namespace Electron {
     type MimeTypedBuffer = Electron.MimeTypedBuffer;
     type MouseInputEvent = Electron.MouseInputEvent;
     type MouseWheelInputEvent = Electron.MouseWheelInputEvent;
+    type NativeHeapProfilerOptions = Electron.NativeHeapProfilerOptions;
     type NavigationEntry = Electron.NavigationEntry;
     type NotificationAction = Electron.NotificationAction;
     type NotificationResponse = Electron.NotificationResponse;

package/dist/version.json

@@ -1,4 +1,4 @@
 {
-  "electronVersion": "45.0.0-beta.3",
-  "extractedAt": "2026-10-14T07:18:14.524Z"
+  "electronVersion": "45.0.0-beta.5",
+  "extractedAt": "2026-10-16T06:22:07.597Z"
 }

package/package.json

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