From bf7dbff858345ca3c5c52b6fd785dbaa057b945d Mon Sep 17 00:00:00 2001 From: Jeremy Rose Date: Mon, 31 Aug 2020 11:27:00 -0700 Subject: [PATCH] docs: note remote deprecation in docs/api/remote (#24941) --- docs/api/remote.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/remote.md b/docs/api/remote.md index 36674ad3d90c..156d24e9eacd 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -4,6 +4,16 @@ Process: [Renderer](../glossary.md#renderer-process) +> ⚠️ WARNING ⚠️ +> The `remote` module is [deprecated](https://github.com/electron/electron/issues/21408). +> Instead of `remote`, use [`ipcRenderer`](ipc-renderer.md) and +> [`ipcMain`](ipc-main.md). +> +> Read more about why the `remote` module is deprecated [here](https://medium.com/@nornagon/electrons-remote-module-considered-harmful-70d69500f31). +> +> If you still want to use `remote` despite the performance and security +> concerns, see [@electron/remote](https://github.com/electron/remote). + The `remote` module provides a simple way to do inter-process communication (IPC) between the renderer process (web page) and the main process.