IpcRendererEvent

Unofficial

Both Official Unofficial

Both Own Inherited

Event object passed to IPC renderer event listeners.

Import:

import type { IpcRendererEvent } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface IpcRendererEvent extends ElectronEvent

Extends: ElectronEvent

Properties

	Property	Type	Description
	ports	MessagePort[]	A list of MessagePorts that were transferred with this message.
	sender	ElectronIpcRenderer	The IpcRenderer instance that emitted the event originally.
	senderId	number	The webContents.id that sent the message. Call event.sender.sendTo(event.senderId, ...) to reply to the message; this only applies to messages sent from a different renderer. Messages sent directly from the main process set senderId to 0.

Methods

	Method	Returns	Description
	preventDefault()	void	Prevents the default action associated with the event. (Inherited from ElectronEvent)