From b04ce6a5c867aae4931517923c535388679994ad Mon Sep 17 00:00:00 2001 From: Milan Burda Date: Thu, 17 Aug 2023 01:52:15 +0200 Subject: [PATCH] docs: add missing webview `render-process-gone` event (#39494) docs: add mising webview 'render-process-gone' event --- docs/api/app.md | 13 +------------ .../structures/render-process-gone-details.md | 13 +++++++++++++ docs/api/web-contents.md | 13 +------------ docs/api/webview-tag.md | 17 +++++++++++++++-- filenames.auto.gni | 1 + 5 files changed, 31 insertions(+), 26 deletions(-) create mode 100644 docs/api/structures/render-process-gone-details.md diff --git a/docs/api/app.md b/docs/api/app.md index 1364ed2664f8..954da5f81f0b 100755 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -412,18 +412,7 @@ Returns: * `event` Event * `webContents` [WebContents](web-contents.md) -* `details` Object - * `reason` string - The reason the render process is gone. Possible values: - * `clean-exit` - Process exited with an exit code of zero - * `abnormal-exit` - Process exited with a non-zero exit code - * `killed` - Process was sent a SIGTERM or otherwise killed externally - * `crashed` - Process crashed - * `oom` - Process ran out of memory - * `launch-failed` - Process never successfully launched - * `integrity-failure` - Windows code integrity checks failed - * `exitCode` Integer - The exit code of the process, unless `reason` is - `launch-failed`, in which case `exitCode` will be a platform-specific - launch failure error code. +* `details` [RenderProcessGoneDetails](structures/render-process-gone-details.md) Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed. diff --git a/docs/api/structures/render-process-gone-details.md b/docs/api/structures/render-process-gone-details.md new file mode 100644 index 000000000000..e48800a5b87d --- /dev/null +++ b/docs/api/structures/render-process-gone-details.md @@ -0,0 +1,13 @@ +# RenderProcessGoneDetails Object + +* `reason` string - The reason the render process is gone. Possible values: + * `clean-exit` - Process exited with an exit code of zero + * `abnormal-exit` - Process exited with a non-zero exit code + * `killed` - Process was sent a SIGTERM or otherwise killed externally + * `crashed` - Process crashed + * `oom` - Process ran out of memory + * `launch-failed` - Process never successfully launched + * `integrity-failure` - Windows code integrity checks failed +* `exitCode` Integer - The exit code of the process, unless `reason` is + `launch-failed`, in which case `exitCode` will be a platform-specific + launch failure error code. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index d4aac970368e..de9c66ed5e9b 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -479,18 +479,7 @@ checking `reason === 'killed'` when you switch to that event. Returns: * `event` Event -* `details` Object - * `reason` string - The reason the render process is gone. Possible values: - * `clean-exit` - Process exited with an exit code of zero - * `abnormal-exit` - Process exited with a non-zero exit code - * `killed` - Process was sent a SIGTERM or otherwise killed externally - * `crashed` - Process crashed - * `oom` - Process ran out of memory - * `launch-failed` - Process never successfully launched - * `integrity-failure` - Windows code integrity checks failed - * `exitCode` Integer - The exit code of the process, unless `reason` is - `launch-failed`, in which case `exitCode` will be a platform-specific - launch failure error code. +* `details` [RenderProcessGoneDetails](structures/render-process-gone-details.md) Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed. diff --git a/docs/api/webview-tag.md b/docs/api/webview-tag.md index 60927b5ce3cd..340365b78c8f 100644 --- a/docs/api/webview-tag.md +++ b/docs/api/webview-tag.md @@ -983,9 +983,22 @@ ipcRenderer.on('ping', () => { }) ``` -### Event: 'crashed' +### Event: 'crashed' _Deprecated_ -Fired when the renderer process is crashed. +Fired when the renderer process crashes or is killed. + +**Deprecated:** This event is superceded by the `render-process-gone` event +which contains more information about why the render process disappeared. It +isn't always because it crashed. + +### Event: 'render-process-gone' + +Returns: + +* `details` [RenderProcessGoneDetails](structures/render-process-gone-details.md) + +Fired when the renderer process unexpectedly disappears. This is normally +because it was crashed or killed. ### Event: 'plugin-crashed' diff --git a/filenames.auto.gni b/filenames.auto.gni index d675196e45dc..d7aeead8c38e 100644 --- a/filenames.auto.gni +++ b/filenames.auto.gni @@ -115,6 +115,7 @@ auto_filenames = { "docs/api/structures/protocol-response.md", "docs/api/structures/rectangle.md", "docs/api/structures/referrer.md", + "docs/api/structures/render-process-gone-details.md", "docs/api/structures/resolved-endpoint.md", "docs/api/structures/resolved-host.md", "docs/api/structures/scrubber-item.md",