ElectronRemote

Unofficial

Both Official Unofficial

Both Own Inherited

Electron @electron/remote module for accessing main process modules from the renderer.

Import:

import type { ElectronRemote } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronRemote

Properties

	Property	Type	Description
	app	ElectronApp	The main process app instance.
	autoUpdater	ElectronAutoUpdater	The main process autoUpdater module.
	BrowserView	typeof ElectronBrowserView	The BrowserView constructor.
	BrowserWindow	typeof ElectronBrowserWindow	The BrowserWindow constructor.
	clipboard	ElectronClipboard	The main process clipboard module.
	contentTracing	ElectronContentTracing	The main process contentTracing module.
	crashReporter	ElectronCrashReporter	The main process crashReporter module.
	desktopCapturer	ElectronDesktopCapturer	The main process desktopCapturer module.
	dialog	ElectronDialog	The main process dialog module.
	globalShortcut	ElectronGlobalShortcut	The main process globalShortcut module.
	inAppPurchase	ElectronInAppPurchase	The main process inAppPurchase module. macOS only.
	ipcMain	ElectronIpcMain	The main process ipcMain module.
	Menu	typeof ElectronMenu	The Menu constructor.
	MenuItem	typeof ElectronMenuItem	The MenuItem constructor.
	MessageChannelMain	typeof ElectronMessageChannelMain	The MessageChannelMain constructor.
	nativeImage	ElectronNativeImageModule	The main process nativeImage module.
	nativeTheme	ElectronNativeTheme	The main process nativeTheme module.
	net	ElectronNet	The main process net module.
	netLog	ElectronNetLog	The main process netLog module.
	Notification	typeof ElectronNotification	The Notification constructor.
	powerMonitor	ElectronPowerMonitor	The main process powerMonitor module.
	powerSaveBlocker	ElectronPowerSaveBlocker	The main process powerSaveBlocker module.
	process	NodeJS.Process	The main process process object.
	protocol	ElectronProtocol	The main process protocol module.
	safeStorage	ElectronSafeStorage	The main process safeStorage module.
	screen	ElectronScreen	The main process screen module.
	session	ElectronSessionModule	The main process session module.
	ShareMenu	typeof ElectronShareMenu	The ShareMenu constructor. macOS only.
	shell	ElectronShell	The main process shell module.
	systemPreferences	ElectronSystemPreferences	The main process systemPreferences module.
	TouchBar	typeof ElectronTouchBar	The TouchBar constructor. macOS only.
	Tray	typeof ElectronTray	The Tray constructor.
	webContents	ElectronWebContentsModule	The main process webContents module.
	webFrameMain	ElectronWebFrameMainModule	The main process webFrameMain module.

Methods

	Method	Returns	Description
	createFunctionWithReturnValue(returnValue)	() => T	Wraps a value in a function that returns it, for passing across the remote boundary.
	getBuiltin(name)	unknown	Returns the main process module built into Electron with the given name.
	getCurrentWebContents()	ElectronWebContents	Returns the web contents of the current renderer process.
	getCurrentWindow()	ElectronBrowserWindow	Returns the BrowserWindow of the current renderer process.
	getGlobal(name)	unknown	Returns the global variable of the given name from the main process.
	require(module)	unknown	Returns the module required from the main process by the given path.

---

Links to this page:

• ElectronModule
• ElectronWebFrameMainModule