feat: unsubscribe from channel

electron/main/ipc/ipc.types.ts

@@ -3,7 +3,10 @@
  * The main process must provide call-response handlers for this API.
  * Excludes the `onMessage` push-style API from main to renderer.
  */
-export type IpcInvokableEvent = keyof Omit<AppAPI, 'onMessage'>;
+export type IpcInvokableEvent = keyof Omit<
+ AppAPI,
+ 'onMessage' | 'removeAllListeners'
+>;
 
 export interface IpcInvokeHandler<K extends IpcInvokableEvent> {
  (params: Parameters<AppAPI[K]>): ReturnType<AppAPI[K]>;

electron/preload/index.d.ts

@@ -63,6 +63,16 @@ declare const appAPI: {
  channel: string,
  callback: (event: Electron.IpcRendererEvent, ...args: any[]) => void
  ) => void;
+ /**
+ * Allows the renderer to unsubscribe from messages from the main process.
+ * Removes all listeners added by the `onMessage` API for a channel.
+ *
+ * For example, when subscribing to messages in a react app, the
+ * `useEffect` hook will subscribe multiple times, once per time the hook
+ * is regenerated. To prevent this, ensure to unsubscribe in the hook's
+ * destroy function. https://stackoverflow.com/a/73458622/470818
+ */
+ removeAllListeners(channel: string): void;
 };
 declare global {
  type TypeOfAppAPI = typeof appAPI;

electron/preload/index.ts

@@ -87,6 +87,18 @@ const appAPI = {
  ) => {
  ipcRenderer.on(channel, callback);
  },
+ /**
+ * Allows the renderer to unsubscribe from messages from the main process.
+ * Removes all listeners added by the `onMessage` API for a channel.
+ *
+ * For example, when subscribing to messages in a react app, the
+ * `useEffect` hook will subscribe multiple times, once per time the hook
+ * is regenerated. To prevent this, ensure to unsubscribe in the hook's
+ * destroy function. https://stackoverflow.com/a/73458622/470818
+ */
+ removeAllListeners(channel: string) {
+ ipcRenderer.removeAllListeners(channel);
+ },
 };
 
 declare global {