From 25d7d247a3f6863edf6ca76733e76c82eaa1c7cd Mon Sep 17 00:00:00 2001 From: "electron-website-docs-updater[bot]" <166660481+electron-website-docs-updater[bot]@users.noreply.github.com> Date: Wed, 21 Jan 2026 19:54:29 +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/.sha | 2 +- docs/latest/api/auto-updater.md | 13 +++++++++++++ docs/latest/api/share-menu.md | 5 +++++ docs/latest/api/shell.md | 26 ++++++++++++++++++++++++++ docs/latest/breaking-changes.md | 12 ++++++++++++ docs/latest/development/style-guide.md | 2 +- 6 files changed, 58 insertions(+), 2 deletions(-) diff --git a/docs/latest/.sha b/docs/latest/.sha index 755207f68..6f6bf3283 100644 --- a/docs/latest/.sha +++ b/docs/latest/.sha @@ -1 +1 @@ -5e91ab8c5086579b228741049b64fe464576dacd \ No newline at end of file +f476b2945979ba80614893f0cce0c42bae061e52 \ No newline at end of file diff --git a/docs/latest/api/auto-updater.md b/docs/latest/api/auto-updater.md index b16129a8b..5c4476ebe 100644 --- a/docs/latest/api/auto-updater.md +++ b/docs/latest/api/auto-updater.md @@ -107,6 +107,11 @@ On Windows only `releaseName` is available. ### Event: 'before-quit-for-update' +```YAML history +added: + - pr-url: https://github.com/electron/electron/pull/12619 +``` + This event is emitted after a user calls `quitAndInstall()`. When this API is called, the `before-quit` event is not emitted before all windows are closed. As a result you should listen to this event if you wish to perform actions before the windows are closed while a process is quitting, as well as listening to `before-quit`. @@ -117,6 +122,14 @@ The `autoUpdater` object has the following methods: ### `autoUpdater.setFeedURL(options)` +```YAML history +changes: + - pr-url: https://github.com/electron/electron/pull/5879 + description: "Added `headers` as a second parameter." + - pr-url: https://github.com/electron/electron/pull/11925 + description: "Changed API to accept a single `options` argument (contains `url`, `headers`, and `serverType` properties)." +``` + * `options` Object * `url` string * `headers` Record\ (optional) _macOS_ - HTTP request headers. diff --git a/docs/latest/api/share-menu.md b/docs/latest/api/share-menu.md index ffe045876..39e1145bc 100644 --- a/docs/latest/api/share-menu.md +++ b/docs/latest/api/share-menu.md @@ -16,6 +16,11 @@ For including the share menu as a submenu of other menus, please use the ## Class: ShareMenu +```YAML history +added: + - pr-url: https://github.com/electron/electron/pull/25629 +``` + > Create share menu on macOS. Process: [Main](../glossary.md#main-process) diff --git a/docs/latest/api/shell.md b/docs/latest/api/shell.md index 7b42285ef..465838464 100644 --- a/docs/latest/api/shell.md +++ b/docs/latest/api/shell.md @@ -36,6 +36,12 @@ Show the given file in a file manager. If possible, select the file. ### `shell.openPath(path)` +```YAML history +added: + - pr-url: https://github.com/electron/electron/pull/20682 + breaking-changes-header: api-changed-shellopenitem-is-now-shellopenpath +``` + * `path` string Returns `Promise` - Resolves with a string containing the error message corresponding to the failure if a failure occurred, otherwise "". @@ -44,6 +50,16 @@ Open the given file in the desktop's default manner. ### `shell.openExternal(url[, options])` +```YAML history +changes: + - pr-url: https://github.com/electron/electron/pull/4508 + description: "Added `activate` option." + - pr-url: https://github.com/electron/electron/pull/15065 + description: "Added `workingDirectory` option." + - pr-url: https://github.com/electron/electron/pull/37139 + description: "Added `logUsage` option." +``` + * `url` string - Max 2081 characters on Windows. * `options` Object (optional) * `activate` boolean (optional) _macOS_ - `true` to bring the opened application to the foreground. The default is `true`. @@ -57,6 +73,12 @@ Open the given external protocol URL in the desktop's default manner. (For examp ### `shell.trashItem(path)` +```YAML history +added: + - pr-url: https://github.com/electron/electron/pull/25114 + breaking-changes-header: deprecated-shellmoveitemtotrash +``` + * `path` string - path to the item to be moved to the trash. Returns `Promise` - Resolves when the operation has been completed. @@ -65,6 +87,10 @@ Rejects if there was an error while deleting the requested item. This moves a path to the OS-specific trash location (Trash on macOS, Recycle Bin on Windows, and a desktop-environment-specific location on Linux). +The path must use the default path separator for the platform (backslash on +Windows). Use `path.resolve()` from the `node:path` module to ensure correct +handling on all filesystems. + ### `shell.beep()` Play the beep sound. diff --git a/docs/latest/breaking-changes.md b/docs/latest/breaking-changes.md index 1fb7c7ba6..f77267b78 100644 --- a/docs/latest/breaking-changes.md +++ b/docs/latest/breaking-changes.md @@ -2684,6 +2684,18 @@ Replace with: https://atom.io/download/electron The following list includes the breaking API changes made in Electron 2.0. +### `autoUpdater` + +```js +// Deprecated +autoUpdater.setFeedURL(url, headers) +// Replace with +autoUpdater.setFeedURL({ + url, + headers +}) +``` + ### `BrowserWindow` ```js diff --git a/docs/latest/development/style-guide.md b/docs/latest/development/style-guide.md index 7728b6fce..3eb7f379f 100644 --- a/docs/latest/development/style-guide.md +++ b/docs/latest/development/style-guide.md @@ -106,7 +106,7 @@ Using `autoUpdater` as an example: ## Methods -### `autoUpdater.setFeedURL(url[, requestHeaders])` +### `autoUpdater.setFeedURL(options)` ``` ### Classes