mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
electron/docs/api/structures/ipc-main-event.md
Samuel Attard 3b74837020 refactor: Split 'Event' docs/types into more specific Event types (#17038) 
* Event = Base event type (with preventDefault)
* IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.)
* IpcRendererEvent = Event that ipcRenderer emits (with sender,
senderId, etc.)
* KeyboardEvent = Event that we emit with keyboard flags (ctrlKey,
altKey, etc.)

This will dramatically improve peoples TS experience with IPC events
2019-02-19 09:24:19 +00:00

581 B
Raw Blame History

IpcMainEvent Object extends Event

  • frameId Integer - The ID of the renderer frame that sent this message
  • returnValue any - Set this to the value to be returned in a syncronous message
  • sender WebContents - Returns the webContents that sent the message
  • reply Function - A function that will send an IPC message to the renderer frane that sent the original message that you are currently handling. You should use this method to "reply" to the sent message in order to guaruntee the reply will go to the correct process and frame.
    • ...args any[] IpcRenderer