From db99a186474cff6cbb5c31f893bf15a920ae0275 Mon Sep 17 00:00:00 2001 From: "electron-website-docs-updater[bot]" <166660481+electron-website-docs-updater[bot]@users.noreply.github.com> Date: Thu, 9 May 2024 02:13:14 +0000 Subject: [PATCH] =?UTF-8?q?chore:=20update=20ref=20to=20docs=20(?= =?UTF-8?q?=F0=9F=A4=96)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/latest/api/base-window.md | 2 +- docs/latest/api/browser-window.md | 2 +- docs/latest/api/net.md | 2 +- docs/latest/api/session.md | 2 +- docs/latest/api/web-contents.md | 2 +- docs/latest/development/debugging-with-symbol-server.md | 2 +- docs/latest/tutorial/esm.md | 3 ++- docs/latest/tutorial/tutorial-1-prerequisites.md | 2 +- docs/latest/tutorial/tutorial-2-first-app.md | 6 ++++-- 9 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/latest/api/base-window.md b/docs/latest/api/base-window.md index 331f4db..dbaab0f 100644 --- a/docs/latest/api/base-window.md +++ b/docs/latest/api/base-window.md @@ -757,7 +757,7 @@ Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and -{ width: 40, height: 50 }. The second argument doesn't care where the extra width and height +\{ width: 40, height: 50 \}. The second argument doesn't care where the extra width and height are within the content view--only that they exist. Sum any extra width and height areas you have within the overall content view. diff --git a/docs/latest/api/browser-window.md b/docs/latest/api/browser-window.md index eb46e92..d25948a 100644 --- a/docs/latest/api/browser-window.md +++ b/docs/latest/api/browser-window.md @@ -879,7 +879,7 @@ Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and -{ width: 40, height: 50 }. The second argument doesn't care where the extra width and height +\{ width: 40, height: 50 \}. The second argument doesn't care where the extra width and height are within the content view--only that they exist. Sum any extra width and height areas you have within the overall content view. diff --git a/docs/latest/api/net.md b/docs/latest/api/net.md index 7e93581..c26f45e 100644 --- a/docs/latest/api/net.md +++ b/docs/latest/api/net.md @@ -73,7 +73,7 @@ requests according to the specified protocol scheme in the `options` object. ### `net.fetch(input[, init])` * `input` string | [GlobalRequest](https://nodejs.org/api/globals.html#request) -* `init` [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options) & { bypassCustomProtocolHandlers?: boolean } (optional) +* `init` [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options) & \{ bypassCustomProtocolHandlers?: boolean \} (optional) Returns `Promise` - see [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response). diff --git a/docs/latest/api/session.md b/docs/latest/api/session.md index 71cf097..f956503 100644 --- a/docs/latest/api/session.md +++ b/docs/latest/api/session.md @@ -702,7 +702,7 @@ Returns `Promise` - Resolves when all connections are closed. #### `ses.fetch(input[, init])` * `input` string | [GlobalRequest](https://nodejs.org/api/globals.html#request) -* `init` [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options) & { bypassCustomProtocolHandlers?: boolean } (optional) +* `init` [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options) & \{ bypassCustomProtocolHandlers?: boolean \} (optional) Returns `Promise` - see [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response). diff --git a/docs/latest/api/web-contents.md b/docs/latest/api/web-contents.md index af91660..06cb052 100644 --- a/docs/latest/api/web-contents.md +++ b/docs/latest/api/web-contents.md @@ -1295,7 +1295,7 @@ Ignore application menu shortcuts while this web contents is focused. #### `contents.setWindowOpenHandler(handler)` -* `handler` Function<{action: 'deny'} | {action: 'allow', outlivesOpener?: boolean, overrideBrowserWindowOptions?: BrowserWindowConstructorOptions}\> +* `handler` Function<\{action: 'deny'\} | \{action: 'allow', outlivesOpener?: boolean, overrideBrowserWindowOptions?: BrowserWindowConstructorOptions\}\> * `details` Object * `url` string - The _resolved_ version of the URL passed to `window.open()`. e.g. opening a window with `window.open('foo')` will yield something like `https://the-origin/the/current/path/foo`. * `frameName` string - Name of the window provided in `window.open()` diff --git a/docs/latest/development/debugging-with-symbol-server.md b/docs/latest/development/debugging-with-symbol-server.md index 45f7fef..ff94453 100644 --- a/docs/latest/development/debugging-with-symbol-server.md +++ b/docs/latest/development/debugging-with-symbol-server.md @@ -22,7 +22,7 @@ calls, and other compiler optimizations. The only workaround is to build an unoptimized local build. The official symbol server URL for Electron is -. +[https://symbols.electronjs.org](https://symbols.electronjs.org). You cannot visit this URL directly, you must add it to the symbol path of your debugging tool. In the examples below, a local cache directory is used to avoid repeatedly fetching the PDB from the server. Replace `c:\code\symbols` with an diff --git a/docs/latest/tutorial/esm.md b/docs/latest/tutorial/esm.md index 4761883..4c76f56 100644 --- a/docs/latest/tutorial/esm.md +++ b/docs/latest/tutorial/esm.md @@ -78,7 +78,8 @@ JavaScript transpilers (e.g. Babel, TypeScript) have historically supported ES M syntax before Node.js supported ESM imports by turning these calls to CommonJS `require` calls. -
Example: @babel/plugin-transform-modules-commonjs +
+Example: @babel/plugin-transform-modules-commonjs The `@babel/plugin-transform-modules-commonjs` plugin will transform ESM imports down to `require` calls. The exact syntax will depend on the diff --git a/docs/latest/tutorial/tutorial-1-prerequisites.md b/docs/latest/tutorial/tutorial-1-prerequisites.md index 397bb81..dff22af 100644 --- a/docs/latest/tutorial/tutorial-1-prerequisites.md +++ b/docs/latest/tutorial/tutorial-1-prerequisites.md @@ -121,7 +121,7 @@ need to install Node.js themselves as a prerequisite to running your app. To check which version of Node.js is running in your app, you can access the global [`process.versions`][] variable in the main process or preload script. You can also reference -. +[https://releases.electronjs.org/releases.json](https://releases.electronjs.org/releases.json). ::: diff --git a/docs/latest/tutorial/tutorial-2-first-app.md b/docs/latest/tutorial/tutorial-2-first-app.md index 9ede9b2..e8a91aa 100644 --- a/docs/latest/tutorial/tutorial-2-first-app.md +++ b/docs/latest/tutorial/tutorial-2-first-app.md @@ -222,7 +222,8 @@ with CommonJS module syntax: - [app][app], which controls your application's event lifecycle. - [BrowserWindow][browser-window], which creates and manages app windows. -
Module capitalization conventions +
+Module capitalization conventions You might have noticed the capitalization difference between the **a**pp and **B**rowser**W**indow modules. Electron follows typical JavaScript conventions here, @@ -231,7 +232,8 @@ Notification) whereas camelCase modules are not instantiable (e.g. app, ipcRende
-
Typed import aliases +
+Typed import aliases For better type checking when writing TypeScript code, you can choose to import main process modules from `electron/main`.