Browse Source

docs: remove outdated ipc example (#37523)

Erick Zhao 2 years ago
parent
commit
f33bf2a271
1 changed files with 7 additions and 33 deletions
  1. 7 33
      docs/api/web-contents.md

+ 7 - 33
docs/api/web-contents.md

@@ -786,7 +786,7 @@ cancel the request.
 
 If no event listener is added for this event, all bluetooth requests will be cancelled.
 
-```javascript
+```javascript title='main.js'
 const { app, BrowserWindow } = require('electron')
 
 let win = null
@@ -1631,7 +1631,7 @@ ipcMain.on('open-devtools', (event, targetContentsId, devtoolsContentsId) => {
 
 An example of showing devtools in a `BrowserWindow`:
 
-```js
+```js title='main.js'
 const { app, BrowserWindow } = require('electron')
 
 let win = null
@@ -1714,40 +1714,14 @@ Algorithm][SCA], just like [`postMessage`][], so prototype chains will not be
 included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will
 throw an exception.
 
-> **NOTE**: Sending non-standard JavaScript types such as DOM objects or
-> special Electron objects will throw an exception.
-
-The renderer process can handle the message by listening to `channel` with the
-[`ipcRenderer`](ipc-renderer.md) module.
-
-An example of sending messages from the main process to the renderer process:
+:::warning
 
-```javascript
-// In the main process.
-const { app, BrowserWindow } = require('electron')
-let win = null
+Sending non-standard JavaScript types such as DOM objects or
+special Electron objects will throw an exception.
 
-app.whenReady().then(() => {
-  win = new BrowserWindow({ width: 800, height: 600 })
-  win.loadURL(`file://${__dirname}/index.html`)
-  win.webContents.on('did-finish-load', () => {
-    win.webContents.send('ping', 'whoooooooh!')
-  })
-})
-```
+:::
 
-```html
-<!-- index.html -->
-<html>
-<body>
-  <script>
-    require('electron').ipcRenderer.on('ping', (event, message) => {
-      console.log(message) // Prints 'whoooooooh!'
-    })
-  </script>
-</body>
-</html>
-```
+For additional reading, refer to [Electron's IPC guide](../tutorial/ipc.md).
 
 #### `contents.sendToFrame(frameId, channel, ...args)`