Add ipc.callFocusedRenderer (#27)

Author: ulken

index.d.ts

@@ -31,6 +31,31 @@ export interface MainProcessIpc extends IpcMain {
 		data?: T
 	): Promise<unknown>;
 
+	/**
+	Send a message to the focused window, as determined by `electron.BrowserWindow.getFocusedWindow`.
+
+	In the renderer process, use `ipcRenderer.answerMain` to reply to this message.
+
+	@param channel - The channel to send the message on.
+	@param data - The data to send to the receiver.
+	@returns - The reply from the renderer process.
+
+	@example
+	```
+	import {ipcMain as ipc} from 'electron-better-ipc';
+
+	(async () => {
+		const emoji = await ipc.callFocusedRenderer('get-emoji', 'unicorn');
+		console.log(emoji);
+		//=> '🦄'
+	})();
+	```
+	*/
+	callFocusedRenderer<T>(
+		channel: string,
+		data?: T
+	): Promise<unknown>;
+
 	/**
 	This method listens for a message from `ipcRenderer.callMain` defined in a renderer process and replies back.
 

readme.md

@@ -89,13 +89,10 @@ ipc.answerMain('get-emoji', async emojiName => {
 ###### Main
 
 ```js
-const electron = require('electron');
 const {ipcMain: ipc} = require('electron-better-ipc');
 
-const browserWindow = electron.BrowserWindow.getFocusedWindow();
-
 (async () => {
-	const emoji = await ipc.callRenderer(browserWindow, 'get-emoji', 'unicorn');
+	const emoji = await ipc.callFocusedRenderer('get-emoji', 'unicorn');
 	console.log(emoji);
 	//=> '🦄'
 })();
@@ -114,7 +111,7 @@ Send a message to the given window.
 
 In the renderer process, use `ipcRenderer.answerMain` to reply to this message.
 
-Returns a `Promise<unknown>` with the reply from the renderer process..
+Returns a `Promise<unknown>` with the reply from the renderer process.
 
 #### browserWindow
 
@@ -134,6 +131,26 @@ Type: `unknown`
 
 The data to send to the receiver.
 
+### ipcMain.callFocusedRenderer(channel, [data])
+
+Send a message to the focused window, as determined by `electron.BrowserWindow.getFocusedWindow`.
+
+In the renderer process, use `ipcRenderer.answerMain` to reply to this message.
+
+Returns a `Promise<unknown>` with the reply from the renderer process.
+
+#### channel
+
+Type: `string`
+
+The channel to send the message on.
+
+#### data
+
+Type: `unknown`
+
+The data to send to the receiver.
+
 ### ipcMain.answerRenderer(channel, callback)
 
 This method listens for a message from `ipcRenderer.callMain` defined in a renderer process and replies back.

source/main.js

@@ -43,6 +43,8 @@ ipc.callRenderer = (browserWindow, channel, data) => new Promise((resolve, rejec
 	}
 });
 
+ipc.callFocusedRenderer = (...args) => ipc.callRenderer(BrowserWindow.getFocusedWindow(), ...args);
+
 ipc.answerRenderer = (channel, callback) => {
 	const sendChannel = util.getSendChannel(channel);
 

test/fixture/index.js

@@ -10,6 +10,11 @@ ipc.answerRenderer('test', async data => {
 	return 'test:main:answer';
 });
 
+ipc.answerRenderer('test-focused', async data => {
+	console.log('test-focused:main:data-from-renderer:', data);
+	return 'test-focused:main:answer';
+});
+
 ipc.answerRenderer('test-error', async () => {
 	throw new Error('test-error:main:answer');
 });
@@ -30,4 +35,7 @@ let mainWindow;
 
 	const answer = await ipc.callRenderer(mainWindow, 'test', 'optional-data');
 	console.log('test:main:answer-from-renderer:', answer);
+
+	const answerFromFocusedRenderer = await ipc.callFocusedRenderer('test-focused', 'optional-data');
+	console.log('test-focused:main:answer-from-renderer', answerFromFocusedRenderer);
 })();

test/fixture/renderer.js

@@ -14,3 +14,12 @@ ipc.callMain('test-error').catch(error => {
 	console.log('test-error:renderer:from-main:is-error', error instanceof Error);
 	console.log('test-error:renderer:from-main:error-message', error.message);
 });
+
+ipc.callMain('test-focused', 'optional-data').then(answer => {
+	console.log('test-focused:renderer:answer-from-main:', answer);
+})
+
+ipc.answerMain('test-focused', data => {
+	console.log('test-focused:renderer:data-from-main:', data);
+	return 'test-focused:renderer:answer-data';
+});

test/fixture/test.js

@@ -47,8 +47,12 @@ test('main', async t => {
 		// https://github.com/electron/spectron/issues/282
 		'"test-error:renderer:from-main:error-message" "test-error:main:answer"',
 		'"test-error:renderer:from-main:is-error" true',
+		'"test-focused:renderer:answer-from-main:" "test-focused:main:answer"',
+		'"test-focused:renderer:data-from-main:" "optional-data"',
 		'"test:renderer:answer-from-main:" "test:main:answer"',
 		'"test:renderer:data-from-main:" "optional-data"',
+		'test-focused:main:answer-from-renderer test-focused:renderer:answer-data',
+		'test-focused:main:data-from-renderer: optional-data',
 		'test:main:answer-from-renderer: test:renderer:answer-data',
 		'test:main:data-from-renderer: optional-data'
 	]);