docs: add missing webview render-process-gone event (#39494)

docs: add mising webview 'render-process-gone' event
This commit is contained in:
Milan Burda 2023-08-17 01:52:15 +02:00 committed by GitHub
parent fce9ed65d6
commit b04ce6a5c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 31 additions and 26 deletions

View file

@ -412,18 +412,7 @@ Returns:
* `event` Event * `event` Event
* `webContents` [WebContents](web-contents.md) * `webContents` [WebContents](web-contents.md)
* `details` Object * `details` [RenderProcessGoneDetails](structures/render-process-gone-details.md)
* `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.
Emitted when the renderer process unexpectedly disappears. This is normally Emitted when the renderer process unexpectedly disappears. This is normally
because it was crashed or killed. because it was crashed or killed.

View file

@ -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.

View file

@ -479,18 +479,7 @@ checking `reason === 'killed'` when you switch to that event.
Returns: Returns:
* `event` Event * `event` Event
* `details` Object * `details` [RenderProcessGoneDetails](structures/render-process-gone-details.md)
* `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.
Emitted when the renderer process unexpectedly disappears. This is normally Emitted when the renderer process unexpectedly disappears. This is normally
because it was crashed or killed. because it was crashed or killed.

View file

@ -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' ### Event: 'plugin-crashed'

View file

@ -115,6 +115,7 @@ auto_filenames = {
"docs/api/structures/protocol-response.md", "docs/api/structures/protocol-response.md",
"docs/api/structures/rectangle.md", "docs/api/structures/rectangle.md",
"docs/api/structures/referrer.md", "docs/api/structures/referrer.md",
"docs/api/structures/render-process-gone-details.md",
"docs/api/structures/resolved-endpoint.md", "docs/api/structures/resolved-endpoint.md",
"docs/api/structures/resolved-host.md", "docs/api/structures/resolved-host.md",
"docs/api/structures/scrubber-item.md", "docs/api/structures/scrubber-item.md",