electron/internals

Classes

Class	Description
ElectronBrowserView	Electron BrowserView for embedding additional web content in a ElectronBrowserWindow.
ElectronBrowserWindow	Electron BrowserWindow for creating and managing application windows.
ElectronClientRequest	An HTTP/HTTPS request issued through the net module.
ElectronIncomingMessage	An HTTP response message returned by a ClientRequest.
ElectronMenu	Electron Menu for creating native application menus and context menus.
ElectronMenuItem	Electron MenuItem for adding items to native application menus.
ElectronMessageChannelMain	A main-process channel that owns a pair of connected ElectronMessagePortMain ports.
ElectronNotification	Electron Notification for creating and showing native OS notifications.
ElectronShareMenu	Electron ShareMenu for presenting the native share sheet for a ElectronSharingItem.
ElectronTouchBar	Electron TouchBar for building a macOS Touch Bar layout.
ElectronTouchBarButton	A button item for a ElectronTouchBar.
ElectronTouchBarColorPicker	A color picker item for a ElectronTouchBar.
ElectronTouchBarGroup	A group item for a ElectronTouchBar.
ElectronTouchBarLabel	A label item for a ElectronTouchBar.
ElectronTouchBarOtherItemsProxy	A proxy item that reserves space for system-provided items in a ElectronTouchBar.
ElectronTouchBarPopover	A popover item for a ElectronTouchBar.
ElectronTouchBarScrubber	A scrubber item for a ElectronTouchBar.
ElectronTouchBarSegmentedControl	A segmented control item for a ElectronTouchBar.
ElectronTouchBarSlider	A slider item for a ElectronTouchBar.
ElectronTouchBarSpacer	A spacer item for a ElectronTouchBar.
ElectronTray	Electron Tray for adding icons and context menus to the system’s notification area.

Interfaces

Interface	Description
BrowserWindowConstructorOptions	Options for creating a new BrowserWindow.
ElectronAboutPanelOptionsOptions	Options for the application’s about panel.
ElectronAccelerator	Electron Accelerator, a string representing a keyboard shortcut.
ElectronAddRepresentationOptions	Options for NativeImage.addRepresentation.
ElectronAnimationSettings	Describes the system-wide animation settings.
ElectronApp	Electron App for controlling the application lifecycle.
ElectronAppDetailsOptions	Options for the window’s taskbar button (Windows only).
ElectronApplicationInfoForProtocolReturnValue	Information about the application handling a given protocol.
ElectronAuthenticationResponseDetails	Details about an authentication request emitted with the login event.
ElectronAuthInfo	Information about an authentication challenge.
ElectronAutoResizeOptions	Options controlling how a ElectronBrowserView auto-resizes with its window.
ElectronAutoUpdater	Enables apps to automatically update themselves.
ElectronBeforeSendResponse	Response object returned by an onBeforeSendHeaders web-request listener callback.
ElectronBluetoothDevice	A Bluetooth device available for selection.
ElectronBluetoothPairingHandlerHandlerDetails	Details passed to the Session.setBluetoothPairingHandler handler describing a Bluetooth pairing request.
ElectronBluetoothPairingResponse	Response returned to the Session.setBluetoothPairingHandler callback to resolve a Bluetooth pairing request.
ElectronBrowserViewConstructorOptions	Options for creating an ElectronBrowserView.
ElectronBrowserWindowLoadFileOptions	Options for ElectronBrowserWindow.loadFile.
ElectronBrowserWindowLoadURLOptions	Options for ElectronBrowserWindow.loadURL.
ElectronCertificate	An Electron certificate.
ElectronCertificatePrincipal	Principal (subject or issuer) of an Electron certificate.
ElectronCertificateTrustDialogOptions	Options for Electron certificate trust dialog.
ElectronClearCodeCachesOptions	Options controlling which code caches are cleared.
ElectronClearStorageDataOptions	Options controlling which storage data is cleared.
ElectronClientRequestConstructorOptions	Options for constructing a ClientRequest.
ElectronClipboard	Electron Clipboard for reading and writing system clipboard data.
ElectronClipboardBookmark	A bookmark read from the clipboard.
ElectronCommandLine	Reads and manipulates the command line arguments that Chromium uses.
ElectronConfig	Proxy configuration for a session.
ElectronConfigureHostResolverOptions	Options for configuring host resolution (DNS and DNS-over-HTTPS).
ElectronContentTracing	Collects tracing data from Chromium’s content module for finding performance bottlenecks and slow operations.
ElectronContextBridge	Electron ContextBridge for exposing APIs from an isolated preload script to the main world.
ElectronContextMenuParams	Parameters describing the context in which a context menu was invoked.
ElectronContinueActivityDetails	Details about a Handoff activity being continued from another device.
ElectronCookie	A cookie stored in an Electron session.
ElectronCookies	Queries and modifies a session’s cookies.
ElectronCookiesGetFilter	Filter used to query cookies from an Electron session.
ElectronCookiesSetDetails	Details used to set a cookie on an Electron session.
ElectronCPUUsage	CPU usage statistics for a process.
ElectronCrashReport	The date and ID of a crash report.
ElectronCrashReporter	Electron CrashReporter for submitting crash reports to a remote server.
ElectronCrashReporterStartOptions	Options for crashReporter.start.
ElectronCreateFromBitmapOptions	Options for nativeImage.createFromBitmap.
ElectronCreateFromBufferOptions	Options for nativeImage.createFromBuffer.
ElectronCreateInterruptedDownloadOptions	Options used to resume a cancelled or interrupted download from a previous session.
ElectronCustomScheme	A custom scheme to be registered with a protocol, along with its privileges.
ElectronData	Data to write to the clipboard.
ElectronDebugger	A debugger instance for a web contents, used to communicate with the Chrome DevTools Protocol.
ElectronDefaultFontFamily	Default font families used by the renderer, keyed by generic family.
ElectronDesktopCapturer	Electron desktop capturer for accessing information about media sources that can be used to capture audio and video from the desktop using the navigator.mediaDevices.getUserMedia API.
ElectronDesktopCapturerSource	A screen or individual window that can be captured, returned by desktopCapturer.getSources.
ElectronDetails	Details about a child process that has gone (crashed or killed).
ElectronDevicePermissionHandlerHandlerDetails	Details passed to a device permission handler.
ElectronDialog	Electron Dialog for showing native system dialogs.
ElectronDidCreateWindowDetails	Details about a window created via window.open.
ElectronDisplay	Describes a display connected to the system.
ElectronDisplayBalloonOptions	Options for ElectronTray.displayBalloon.
ElectronDock	Performs actions on the app icon in the user’s dock on macOS.
ElectronDownloadItem	Controls and reports on a file download in a session.
ElectronEditFlags	Flags indicating which editing actions the renderer believes it can perform.
ElectronEnableNetworkEmulationOptions	Options for emulating network conditions for a session.
ElectronEvent	Electron event object passed to event listeners, extending the DOM Event.
ElectronExtension	A loaded Chrome extension.
ElectronFeedURLOptions	Options for configuring the auto updater feed URL.
ElectronFileFilter	File filter for Electron dialog file type selection.
ElectronFileIconOptions	Options for fetching a file’s associated icon.
ElectronFindInPageOptions	Options for a find-in-page request.
ElectronFocusOptions	Options for focusing the application.
ElectronFrameCreatedDetails	Details about a newly created frame.
ElectronFromPartitionOptions	Options used when creating a session from a partition.
ElectronGlobalShortcut	Detects keyboard events when the application does not have keyboard focus.
ElectronGPUFeatureStatus	The Graphics Feature Status from chrome://gpu/.
ElectronHandlerDetails	Details about a window open request handled by a window open handler.
ElectronHeadersReceivedResponse	Response object returned by an onHeadersReceived web-request listener callback.
ElectronHIDDevice	A HID device available for selection via the Web HID API.
ElectronHidDeviceAddedDetails	Details passed to the hid-device-added session event.
ElectronHidDeviceRemovedDetails	Details passed to the hid-device-removed session event.
ElectronIgnoreMouseEventsOptions	Options for ElectronBrowserWindow.setIgnoreMouseEvents.
ElectronImportCertificateOptions	Options for importing a certificate into the platform certificate store.
ElectronInAppPurchase	In-app purchases on the Mac App Store.
ElectronInfo	Security origin, content security policy and name of an isolated world.
ElectronInput	Input properties describing a keyboard event dispatched to the page.
ElectronInputEvent	Base shape shared by every Electron input event passed to ElectronWebContents.sendInputEvent.
ElectronInsertCSSOptions	Options for inserting CSS into a web page.
ElectronIpcMain	Electron IPC main for communicating with renderer processes from the main process.
ElectronIpcMainEvent	Event passed as the first argument to ipcMain on/once listeners.
ElectronIpcMainInvokeEvent	Event passed as the first argument to ipcMain handle/handleOnce handlers.
ElectronIpcRenderer	Electron IPC renderer for communicating with the main process.
ElectronItem	The item to drag during a drag-and-drop operation.
ElectronJumpListCategory	A category in a Windows Jump List.
ElectronJumpListItem	A single item in a Windows Jump List.
ElectronJumpListSettings	Current settings of the Windows Jump List.
ElectronKeyboardEvent	Modifier-key state describing how an accelerator-triggered event was activated.
ElectronKeyboardInputEvent	Keyboard input event passed to ElectronWebContents.sendInputEvent to inject a trusted key press.
ElectronLaunchItems	A registry-backed login launch item on Windows.
ElectronLoadExtensionOptions	Options controlling how an extension is loaded.
ElectronLoginItemSettings	The app’s login item settings.
ElectronLoginItemSettingsOptions	Options for querying the app’s login item settings.
ElectronMargins	The margins of a printed web page.
ElectronMediaFlags	Flags describing the state of a media element under the context menu.
ElectronMemoryInfo	Memory usage statistics for a process.
ElectronMemoryUsageDetails	Usage information for one of Blink’s internal memory caches.
ElectronMenuItemConstructorOptions	Options for constructing an Electron ElectronMenuItem.
ElectronMenuPopupOptions	Options for popping up a context menu.
ElectronMessageBoxOptions	Options for Electron message box dialog.
ElectronMessageBoxReturnValue	Return value from an Electron message box dialog.
ElectronMessageBoxSyncOptions	Options for Electron synchronous message box dialog.
ElectronMessageDetails	Details of a console message logged by a service worker.
ElectronMessageEvent	Event emitted when a MessagePortMain receives a message.
ElectronMessagePortMain	The main-process end of a MessagePort channel.
ElectronModule	The Electron library module type, representing the window.electron object.
ElectronMouseInputEvent	Mouse input event passed to ElectronWebContents.sendInputEvent to inject a trusted pointer event.
ElectronMouseWheelInputEvent	Mouse wheel input event passed to ElectronWebContents.sendInputEvent to inject a trusted scroll.
ElectronMoveToApplicationsFolderOptions	Options for moving the application into the Applications folder.
ElectronNativeImage	Electron NativeImage for handling tray, dock, and application images.
ElectronNativeImageModule	Electron nativeImage module for creating tray, dock, and application images from various sources.
ElectronNativeImageScaleFactorOptions	Options for NativeImage scale factor operations.
ElectronNativeImageSize	The size of a NativeImage.
ElectronNativeTheme	Electron NativeTheme for reading and updating the system’s theme preferences.
ElectronNet	Issues HTTP/HTTPS requests using Chromium’s native networking library.
ElectronNetLog	Records network events for a session to a file for later analysis.
ElectronNewWindowWebContentsEvent	The event emitted for the deprecated new-window event.
ElectronNotificationAction	An action button shown on a native notification.
ElectronNotificationConstructorOptions	Options for constructing an ElectronNotification.
ElectronNotificationResponse	User’s response to a native notification.
ElectronOnBeforeRedirectListenerDetails	Details passed to an onBeforeRedirect web-request listener.
ElectronOnBeforeRequestListenerDetails	Details passed to an onBeforeRequest web-request listener.
ElectronOnBeforeSendHeadersListenerDetails	Details passed to an onBeforeSendHeaders web-request listener.
ElectronOnCompletedListenerDetails	Details passed to an onCompleted web-request listener.
ElectronOnErrorOccurredListenerDetails	Details passed to an onErrorOccurred web-request listener.
ElectronOnHeadersReceivedListenerDetails	Details passed to an onHeadersReceived web-request listener.
ElectronOnResponseStartedListenerDetails	Details passed to an onResponseStarted web-request listener.
ElectronOnSendHeadersListenerDetails	Details passed to an onSendHeaders web-request listener.
ElectronOpenDialogOptions	Options for Electron open file dialog.
ElectronOpenDialogReturnValue	Return value from an Electron open file dialog.
ElectronOpenDialogSyncOptions	Options for Electron synchronous open file dialog.
ElectronPageRanges	A range of pages to print.
ElectronParameters	Parameters for device emulation.
ElectronPayment	A payment in the Mac App Store payment queue.
ElectronPaymentDiscount	Details of a discount offer to apply to a payment.
ElectronPermissionCheckHandlerHandlerDetails	Details passed to a permission check handler.
ElectronPermissionRequestHandlerHandlerDetails	Details passed to a permission request handler.
ElectronPoint	Represents a point with x and y coordinates.
ElectronPostBody	The post data sent to a new window.
ElectronPowerMonitor	Electron powerMonitor module for monitoring power state changes.
ElectronPowerSaveBlocker	Electron powerSaveBlocker module for blocking the system from entering low-power (sleep) mode.
ElectronPreconnectOptions	Options controlling how sockets are preconnected to an origin.
ElectronPrinterInfo	Information about a system printer.
ElectronPrinterInfoOptions	An object containing a variable number of platform-specific printer information entries.
ElectronPrintToPDFOptions	Options for printing a web page to PDF.
ElectronPrivileges	Privileges granted to a custom scheme registered with a protocol.
ElectronProcessMetric	Memory and CPU usage statistics for a process associated with the app.
ElectronProduct	A product available for purchase from the Mac App Store.
ElectronProductDiscount	A discount offer for a product in the Mac App Store.
ElectronProductSubscriptionPeriod	The period details for products that are subscriptions.
ElectronProgressBarOptions	Options for ElectronBrowserWindow.setProgressBar.
ElectronProtocol	Registers and intercepts custom protocol schemes for a session.
ElectronProtocolRequest	A request passed to a protocol handler.
ElectronProtocolResponse	A response returned from a protocol handler callback.
ElectronProtocolResponseUploadData	Upload data used as the body of a protocol response for POST requests.
ElectronProvider	A spell check provider for input fields and text areas.
ElectronRectangle	Represents a rectangle with position and dimensions.
ElectronReferrer	Represents an HTTP referrer and its policy.
ElectronRegistrationCompletedDetails	Details of a completed service worker registration.
ElectronRelaunchOptions	Options for relaunching the application.
ElectronRemote	Electron @electron/remote module for accessing main process modules from the renderer.
ElectronRenderProcessGoneDetails	Details about a renderer process that has gone (crashed or killed).
ElectronRequest	A certificate verification request passed to a certificate verify proc.
ElectronResizeOptions	Options for NativeImage.resize.
ElectronResourceUsage	Usage information of Blink’s internal memory caches.
ElectronResponse	Response object returned by an onBeforeRequest web-request listener callback.
ElectronResult	The result of a find-in-page request.
ElectronSafeStorage	Electron safeStorage module for encrypting and decrypting strings using OS-level cryptography.
ElectronSaveDialogOptions	Options for Electron save file dialog.
ElectronSaveDialogReturnValue	Return value from an Electron save file dialog.
ElectronSaveDialogSyncOptions	Options for Electron synchronous save file dialog.
ElectronScreen	Electron Screen for retrieving information about screen size, displays, cursor position, and so on.
ElectronScrubberItem	An item shown in a ElectronTouchBarScrubber.
ElectronSegmentedControlSegment	A segment shown in a ElectronTouchBarSegmentedControl.
ElectronSelectHidDeviceDetails	Details passed to the select-hid-device session event.
ElectronSerialPort	A serial port available for selection via the Web Serial API.
ElectronServiceWorkerInfo	Information about a running service worker.
ElectronServiceWorkers	Provides access to the service workers registered within a session.
ElectronSessionModule	The session module accessor exposed by Electron, providing the default session and a factory for partition-based sessions.
ElectronSettings	Settings for the app’s login item.
ElectronSharedWorkerInfo	Information about a shared worker.
ElectronSharingItem	Electron SharingItem describing the content to share via the shareMenu role.
ElectronShell	Electron Shell for managing files and URLs using their default applications.
ElectronShellOpenExternalOptions	Options for opening an external URL.
ElectronShortcutDetails	Details of a shortcut link used by readShortcutLink and writeShortcutLink.
ElectronSize	Represents dimensions with width and height.
ElectronSourcesOptions	Options for desktopCapturer.getSources.
ElectronSSLConfigConfig	SSL configuration for a session.
ElectronStartLoggingOptions	Options controlling how network events are captured when logging starts.
ElectronSystemPreferences	Electron SystemPreferences for reading and writing system-wide preferences.
ElectronTask	A task in the Tasks category of a Windows Jump List.
ElectronThumbarButton	A button in a thumbnail toolbar (Windows only).
ElectronTitleBarOverlay	Configuration for the Window Controls Overlay when creating a window.
ElectronTitleBarOverlayOptions	Options for ElectronBrowserWindow.setTitleBarOverlay.
ElectronTitleOptions	Options for ElectronTray.setTitle.
ElectronTouchBarButtonConstructorOptions	Options for creating a ElectronTouchBarButton.
ElectronTouchBarColorPickerConstructorOptions	Options for creating a ElectronTouchBarColorPicker.
ElectronTouchBarConstructorOptions	Options for creating a ElectronTouchBar.
ElectronTouchBarGroupConstructorOptions	Options for creating a ElectronTouchBarGroup.
ElectronTouchBarLabelConstructorOptions	Options for creating a ElectronTouchBarLabel.
ElectronTouchBarPopoverConstructorOptions	Options for creating a ElectronTouchBarPopover.
ElectronTouchBarScrubberConstructorOptions	Options for creating a ElectronTouchBarScrubber.
ElectronTouchBarSegmentedControlConstructorOptions	Options for creating a ElectronTouchBarSegmentedControl.
ElectronTouchBarSliderConstructorOptions	Options for creating a ElectronTouchBarSlider.
ElectronTouchBarSpacerConstructorOptions	Options for creating a ElectronTouchBarSpacer.
ElectronTraceBufferUsageReturnValue	The maximum usage across processes of the trace buffer.
ElectronTraceCategoriesAndOptions	Legacy trace configuration controlling which category groups are traced and how.
ElectronTraceConfig	Trace configuration controlling which categories are traced and how the recording behaves.
ElectronTransaction	A transaction in the Mac App Store payment queue.
ElectronUploadData	A chunk of upload data attached to a network request.
ElectronUploadFile	A file to be uploaded as part of a request body.
ElectronUploadProgress	Progress information about the upload portion of a ClientRequest.
ElectronUploadRawData	Raw data to be uploaded as part of a request body.
ElectronUserDefaultTypes	Maps NSUserDefaults type names to their corresponding TypeScript types.
ElectronVisibleOnAllWorkspacesOptions	Options for ElectronBrowserWindow.setVisibleOnAllWorkspaces.
ElectronWebContents	Electron WebContents for rendering and controlling a web page. Note: the upstream static factories (fromId, fromDevToolsTargetId, getAllWebContents, getFocusedWebContents) cannot be expressed on a plain interface and are therefore omitted here.
ElectronWebContentsDevToolsOptions	Options for opening developer tools.
ElectronWebContentsModule	The webContents module accessor exposed by Electron, providing static factory and lookup methods for WebContents instances.
ElectronWebContentsPrintOptions	Options for printing a web page.
ElectronWebFrame	Electron WebFrame for customizing the rendering of the current web page in the renderer process.
ElectronWebFrameMain	A frame in the main process, representing a renderer frame. Note: The upstream static fromId(processId, routingId) factory cannot be expressed on a plain interface and is therefore omitted here.
ElectronWebFrameMainModule	The webFrameMain module accessor exposed on ElectronRemote, distinct from the ElectronWebFrameMain class it returns.
ElectronWebRequest	Intercepts and observes a session’s network requests at various life-cycle stages.
ElectronWebRequestFilter	Filter used to narrow which requests a web-request listener receives.
ElectronWebSource	A script source to evaluate in an isolated world.
ElectronWebviewTag	Electron WebviewTag for embedding external web content in the application.
ElectronWebviewTagFindInPageOptions	Options for finding text in a webview page.
ElectronWebviewTagPrintOptions	Options for printing a webview page.
ElectronWillResizeDetails	Details about a pending window resize, emitted with the will-resize event.
ElectronWindowOpenHandlerResponse	Response returned by the ElectronWebContents.setWindowOpenHandler handler, deciding whether a requested new window is allowed or denied.
IpcRendererEvent	Event object passed to IPC renderer event listeners.
Session	Electron session for managing browser sessions, cookies, cache, network, and extensions. Note: The upstream static fromPartition(...) and static defaultSession members cannot be expressed as statics on a plain interface, so they are modelled here as instance members.
WebPreferences	Web preferences for configuring Electron web content behavior.