electron-types 37.10.2 → 38.2.0

package/dist/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 37.10.2
+// Type definitions for Electron 38.2.0
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/typescript-definitions
@@ -1048,30 +1048,6 @@ declare namespace Electron {
      * You should seek to use the `steal` option as sparingly as possible.
      */
     focus(options?: FocusOptions): void;
-    /**
-     * Array of strings naming currently enabled accessibility support components.
-     * Possible values:
-     *
-     * * `nativeAPIs` - Native OS accessibility APIs integration enabled.
-     * * `webContents` - Web contents accessibility tree exposure enabled.
-     * * `inlineTextBoxes` - Inline text boxes (character bounding boxes) enabled.
-     * * `extendedProperties` - Extended accessibility properties enabled.
-     * * `screenReader` - Screen reader specific mode enabled.
-     * * `html` - HTML accessibility tree construction enabled.
-     * * `labelImages` - Accessibility support for automatic image annotations.
-     * * `pdfPrinting` - Accessibility support for PDF printing enabled.
-     *
-     * Notes:
-     *
-     * * The array may be empty if no accessibility modes are active.
-     * * Use `app.isAccessibilitySupportEnabled()` for the legacy boolean check; prefer
-     * this method for granular diagnostics or telemetry.
-     *
-     * Example:
-     *
-     * @platform darwin,win32
-     */
-    getAccessibilitySupportFeatures(): string[];
     /**
      * Resolve with an object containing the following:
      *
@@ -1369,13 +1345,6 @@ declare namespace Electron {
      * whether or not the current OS version allows for native emoji pickers.
      */
     isEmojiPanelSupported(): boolean;
-    /**
-     * whether hardware acceleration is currently disabled.
-     *
-     * > [!NOTE] This information is only usable after the `gpu-info-update` event is
-     * emitted.
-     */
-    isHardwareAccelerationEnabled(): boolean;
     /**
      * `true` if the application—including all of its windows—is hidden (e.g. with
      * `Command-H`), `false` otherwise.
@@ -1537,32 +1506,11 @@ declare namespace Electron {
      * This API must be called after the `ready` event is emitted.
      *
      * > [!NOTE] Rendering accessibility tree can significantly affect the performance
-     * of your app. It should not be enabled by default. Calling this method will
-     * enable the following accessibility support features: `nativeAPIs`,
-     * `webContents`, `inlineTextBoxes`, and `extendedProperties`.
+     * of your app. It should not be enabled by default.
      *
      * @platform darwin,win32
      */
     setAccessibilitySupportEnabled(enabled: boolean): void;
-    /**
-     * Possible values are:
-     *
-     * * `nativeAPIs` - Native OS accessibility APIs integration enabled.
-     * * `webContents` - Web contents accessibility tree exposure enabled.
-     * * `inlineTextBoxes` - Inline text boxes (character bounding boxes) enabled.
-     * * `extendedProperties` - Extended accessibility properties enabled.
-     * * `screenReader` - Screen reader specific mode enabled.
-     * * `html` - HTML accessibility tree construction enabled.
-     * * `labelImages` - Accessibility support for automatic image annotations.
-     * * `pdfPrinting` - Accessibility support for PDF printing enabled.
-     *
-     * To disable all supported features, pass an empty array `[]`.
-     *
-     * Example:
-     *
-     * @platform darwin,win32
-     */
-    setAccessibilitySupportFeatures(features: string[]): void;
     /**
      * Sets the activation policy for a given app.
      *
@@ -5877,11 +5825,15 @@ declare namespace Electron {
     /**
      * Prevents the window contents from being captured by other apps.
      *
-     * On macOS it sets the NSWindow's `sharingType` to `NSWindowSharingNone`. On
-     * Windows it calls `SetWindowDisplayAffinity` with `WDA_EXCLUDEFROMCAPTURE`. For
-     * Windows 10 version 2004 and up the window will be removed from capture entirely,
-     * older Windows versions behave as if `WDA_MONITOR` is applied capturing a black
-     * window.
+     * On Windows, it calls `SetWindowDisplayAffinity` with `WDA_EXCLUDEFROMCAPTURE`.
+     * For Windows 10 version 2004 and up the window will be removed from capture
+     * entirely, older Windows versions behave as if `WDA_MONITOR` is applied capturing
+     * a black window.
+     *
+     * On macOS, it sets the `NSWindow`'s `sharingType` to `NSWindowSharingNone`.
+     * Unfortunately, due to an intentional change in macOS, newer Mac applications
+     * that use `ScreenCaptureKit` will capture your window despite
+     * `win.setContentProtection(true)`. See here.
      *
      * @platform darwin,win32
      */
@@ -7837,6 +7789,9 @@ declare namespace Electron {
     /**
      * Sets the string to be displayed in the dock’s badging area.
      *
+     * > [!IMPORTANT] You need to ensure that your application has the permission to
+     * display notifications for this method to work.
+     *
      * @platform darwin
      */
     setBadge(text: string): void;
@@ -8240,7 +8195,7 @@ declare namespace Electron {
      * still return `false`. This behavior is intended by operating systems, since they
      * don't want applications to fight for global shortcuts.
      */
-    isRegistered(accelerator: Accelerator): boolean;
+    isRegistered(accelerator: string): boolean;
     /**
      * Whether or not the shortcut was registered successfully.
      *
@@ -8259,7 +8214,7 @@ declare namespace Electron {
      * * "Media Previous Track"
      * * "Media Stop"
      */
-    register(accelerator: Accelerator, callback: () => void): boolean;
+    register(accelerator: string, callback: () => void): boolean;
     /**
      * Registers a global shortcut of all `accelerator` items in `accelerators`. The
      * `callback` is called when any of the registered shortcuts are pressed by the
@@ -8277,11 +8232,11 @@ declare namespace Electron {
      * * "Media Previous Track"
      * * "Media Stop"
      */
-    registerAll(accelerators: Accelerator[], callback: () => void): void;
+    registerAll(accelerators: string[], callback: () => void): void;
     /**
      * Unregisters the global shortcut of `accelerator`.
      */
-    unregister(accelerator: Accelerator): void;
+    unregister(accelerator: string): void;
     /**
      * Unregisters all of the global shortcuts.
      */
@@ -9116,8 +9071,8 @@ declare namespace Electron {
     // Docs: https://electronjs.org/docs/api/structures/keyboard-input-event
 
     /**
-     * The character that will be sent as the keyboard event. Should only use the valid
-     * key codes in Accelerator.
+     * The character that will be sent as the keyboard event. Should only use valid
+     * Accelerator key codes.
      */
     keyCode: string;
     /**
@@ -9259,13 +9214,15 @@ declare namespace Electron {
     insert(pos: number, menuItem: MenuItem): void;
     /**
      * Pops up this menu as a context menu in the `BaseWindow`.
+     *
+     * > [!TIP] For more details, see the Context Menu guide.
      */
     popup(options?: PopupOptions): void;
     /**
      * A `MenuItem[]` array containing the menu's items.
      *
-     * Each `Menu` consists of multiple `MenuItem`s and each `MenuItem` can have a
-     * submenu.
+     * Each `Menu` consists of multiple `MenuItem` instances and each `MenuItem` can
+     * nest a `Menu` into its `submenu` property.
      */
     items: MenuItem[];
   }
@@ -9283,7 +9240,7 @@ declare namespace Electron {
      */
     accelerator?: Accelerator;
     /**
-     * A `boolean` indicating whether the item is checked, this property can be
+     * A `boolean` indicating whether the item is checked. This property can be
      * dynamically changed.
      *
      * A `checkbox` menu item will toggle the `checked` property on and off when
@@ -9309,7 +9266,7 @@ declare namespace Electron {
      */
     commandId: number;
     /**
-     * A `boolean` indicating whether the item is enabled, this property can be
+     * A `boolean` indicating whether the item is enabled. This property can be
      * dynamically changed.
      */
     enabled: boolean;
@@ -9318,7 +9275,7 @@ declare namespace Electron {
      */
     icon?: (NativeImage) | (string);
     /**
-     * A `string` indicating the item's unique id, this property can be dynamically
+     * A `string` indicating the item's unique id. This property can be dynamically
      * changed.
      */
     id: string;
@@ -9391,7 +9348,7 @@ declare namespace Electron {
      */
     readonly userAccelerator: (Accelerator) | (null);
     /**
-     * A `boolean` indicating whether the item is visible, this property can be
+     * A `boolean` indicating whether the item is visible. This property can be
      * dynamically changed.
      */
     visible: boolean;
@@ -16422,24 +16379,6 @@ declare namespace Electron {
                                    * The image data of the whole frame.
                                    */
                                   image: NativeImage) => void): this;
-    /**
-     * Emitted when a plugin process has crashed.
-     */
-    on(event: 'plugin-crashed', listener: (event: Event,
-                                           name: string,
-                                           version: string) => void): this;
-    off(event: 'plugin-crashed', listener: (event: Event,
-                                           name: string,
-                                           version: string) => void): this;
-    once(event: 'plugin-crashed', listener: (event: Event,
-                                           name: string,
-                                           version: string) => void): this;
-    addListener(event: 'plugin-crashed', listener: (event: Event,
-                                           name: string,
-                                           version: string) => void): this;
-    removeListener(event: 'plugin-crashed', listener: (event: Event,
-                                           name: string,
-                                           version: string) => void): this;
     /**
      * Emitted when the `WebContents` preferred size has changed.
      *
@@ -17400,6 +17339,12 @@ declare namespace Electron {
      * system's default printer if `deviceName` is empty and the default settings for
      * printing.
      *
+     * Some possible `failureReason`s for print failure include:
+     *
+     * * "Invalid printer settings"
+     * * "Print job canceled"
+     * * "Print job failed"
+     *
      * Use `page-break-before: always;` CSS style to force to print to a new page.
      *
      * Example usage:
@@ -17843,17 +17788,25 @@ declare namespace Electron {
      * A child of `webFrame` with the supplied `name`, `null` would be returned if
      * there's no such frame or if the frame is not in the current renderer process.
      */
-    findFrameByName(name: string): WebFrame;
+    findFrameByName(name: string): (WebFrame) | (null);
     /**
      * that has the supplied `routingId`, `null` if not found.
+     *
+     * **Deprecated:** Use the new `webFrame.findFrameByToken` API.
+     *
+     * @deprecated
+     */
+    findFrameByRoutingId(routingId: number): (WebFrame) | (null);
+    /**
+     * that has the supplied `frameToken`, `null` if not found.
      */
-    findFrameByRoutingId(routingId: number): WebFrame;
+    findFrameByToken(frameToken: string): (WebFrame) | (null);
     /**
      * The frame element in `webFrame's` document selected by `selector`, `null` would
      * be returned if `selector` does not select a frame or if the frame is not in the
      * current renderer process.
      */
-    getFrameForSelector(selector: string): WebFrame;
+    getFrameForSelector(selector: string): (WebFrame) | (null);
     /**
      * * `images` MemoryUsageDetails
      * * `scripts` MemoryUsageDetails
@@ -17959,6 +17912,13 @@ declare namespace Electron {
      *
      */
     readonly firstChild: (WebFrame) | (null);
+    /**
+     * A `string` representing the unique frame token in the current renderer process.
+     * Distinct WebFrame instances that refer to the same underlying frame will have
+     * the same `frameToken`.
+     *
+     */
+    readonly frameToken: string;
     /**
      * A `WebFrame | null` representing next sibling frame, the property would be
      * `null` if `webFrame` is the last frame in its parent or if the next sibling is
@@ -17984,6 +17944,9 @@ declare namespace Electron {
      * Distinct WebFrame instances that refer to the same underlying frame will have
      * the same `routingId`.
      *
+     * **Deprecated:** Use the new `webFrame.frameToken` API.
+     *
+     * @deprecated
      */
     readonly routingId: number;
     /**
@@ -17999,6 +17962,11 @@ declare namespace Electron {
 
     // Docs: https://electronjs.org/docs/api/web-frame-main
 
+    /**
+     * A frame with the given process and frame token, or `null` if there is no
+     * WebFrameMain associated with the given IDs.
+     */
+    static fromFrameToken(processId: number, frameToken: string): (WebFrameMain) | (null);
     /**
      * A frame with the given process and routing IDs, or `undefined` if there is no
      * WebFrameMain associated with the given IDs.
@@ -18084,6 +18052,12 @@ declare namespace Electron {
      *
      */
     readonly framesInSubtree: WebFrameMain[];
+    /**
+     * A `string` which uniquely identifies the frame within its associated renderer
+     * process. This is equivalent to `webFrame.frameToken`.
+     *
+     */
+    readonly frameToken: string;
     /**
      * An `Integer` representing the id of the frame's internal FrameTreeNode instance.
      * This id is browser-global and uniquely identifies a frame that hosts content.
@@ -18370,9 +18344,7 @@ declare namespace Electron {
      * If set, this will sandbox the renderer associated with the window, making it
      * compatible with the Chromium OS-level sandbox and disabling the Node.js engine.
      * This is not the same as the `nodeIntegration` option and the APIs available to
-     * the preload script are more limited. Default is `true` since Electron 20. The
-     * sandbox will automatically be disabled when `nodeIntegration` is set to `true`.
-     * Read more about the option here.
+     * the preload script are more limited. Read more about the option here.
      */
     sandbox?: boolean;
     /**
@@ -18762,11 +18734,6 @@ declare namespace Electron {
      */
     addEventListener(event: 'render-process-gone', listener: (event: RenderProcessGoneEvent) => void, useCapture?: boolean): this;
     removeEventListener(event: 'render-process-gone', listener: (event: RenderProcessGoneEvent) => void): this;
-    /**
-     * Fired when a plugin process is crashed.
-     */
-    addEventListener(event: 'plugin-crashed', listener: (event: PluginCrashedEvent) => void, useCapture?: boolean): this;
-    removeEventListener(event: 'plugin-crashed', listener: (event: PluginCrashedEvent) => void): this;
     /**
      * Fired when the WebContents is destroyed.
      */
@@ -20964,7 +20931,10 @@ declare namespace Electron {
      * @platform darwin
      */
     toolTip?: string;
-    accelerator?: Accelerator;
+    /**
+     * An Accelerator string.
+     */
+    accelerator?: string;
     icon?: (NativeImage) | (string);
     /**
      * If false, the menu item will be greyed out and unclickable.
@@ -21735,11 +21705,6 @@ declare namespace Electron {
     fileAccessType?: ('writable' | 'readable');
   }
 
-  interface PluginCrashedEvent extends DOMEvent {
-    name: string;
-    version: string;
-  }
-
   interface PopupOptions {
     /**
      * Default is the focused window.
@@ -23640,7 +23605,6 @@ declare namespace Electron {
     type Parameters = Electron.Parameters;
     type Payment = Electron.Payment;
     type PermissionCheckHandlerHandlerDetails = Electron.PermissionCheckHandlerHandlerDetails;
-    type PluginCrashedEvent = Electron.PluginCrashedEvent;
     type PopupOptions = Electron.PopupOptions;
     type PowerMonitorSpeedLimitChangeEventParams = Electron.PowerMonitorSpeedLimitChangeEventParams;
     type PowerMonitorThermalStateChangeEventParams = Electron.PowerMonitorThermalStateChangeEventParams;
@@ -24017,7 +23981,6 @@ declare namespace Electron {
     type Parameters = Electron.Parameters;
     type Payment = Electron.Payment;
     type PermissionCheckHandlerHandlerDetails = Electron.PermissionCheckHandlerHandlerDetails;
-    type PluginCrashedEvent = Electron.PluginCrashedEvent;
     type PopupOptions = Electron.PopupOptions;
     type PowerMonitorSpeedLimitChangeEventParams = Electron.PowerMonitorSpeedLimitChangeEventParams;
     type PowerMonitorThermalStateChangeEventParams = Electron.PowerMonitorThermalStateChangeEventParams;
@@ -24322,7 +24285,6 @@ declare namespace Electron {
     type Parameters = Electron.Parameters;
     type Payment = Electron.Payment;
     type PermissionCheckHandlerHandlerDetails = Electron.PermissionCheckHandlerHandlerDetails;
-    type PluginCrashedEvent = Electron.PluginCrashedEvent;
     type PopupOptions = Electron.PopupOptions;
     type PowerMonitorSpeedLimitChangeEventParams = Electron.PowerMonitorSpeedLimitChangeEventParams;
     type PowerMonitorThermalStateChangeEventParams = Electron.PowerMonitorThermalStateChangeEventParams;
@@ -24624,7 +24586,6 @@ declare namespace Electron {
     type Parameters = Electron.Parameters;
     type Payment = Electron.Payment;
     type PermissionCheckHandlerHandlerDetails = Electron.PermissionCheckHandlerHandlerDetails;
-    type PluginCrashedEvent = Electron.PluginCrashedEvent;
     type PopupOptions = Electron.PopupOptions;
     type PowerMonitorSpeedLimitChangeEventParams = Electron.PowerMonitorSpeedLimitChangeEventParams;
     type PowerMonitorThermalStateChangeEventParams = Electron.PowerMonitorThermalStateChangeEventParams;
@@ -25018,7 +24979,6 @@ declare namespace Electron {
     type Parameters = Electron.Parameters;
     type Payment = Electron.Payment;
     type PermissionCheckHandlerHandlerDetails = Electron.PermissionCheckHandlerHandlerDetails;
-    type PluginCrashedEvent = Electron.PluginCrashedEvent;
     type PopupOptions = Electron.PopupOptions;
     type PowerMonitorSpeedLimitChangeEventParams = Electron.PowerMonitorSpeedLimitChangeEventParams;
     type PowerMonitorThermalStateChangeEventParams = Electron.PowerMonitorThermalStateChangeEventParams;

package/dist/version.json

@@ -1,4 +1,4 @@
 {
-  "electronVersion": "37.10.2",
-  "extractedAt": "2025-12-24T03:19:42.331Z"
+  "electronVersion": "38.2.0",
+  "extractedAt": "2025-12-24T03:19:30.248Z"
 }

package/package.json

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