Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Aug 16, 2023

Conversation

miniak
Copy link
Contributor

@miniak miniak commented Aug 14, 2023

It should match the webContents events, which are used to implement the webview ones:

#### Event: 'crashed' _Deprecated_
Returns:
* `event` Event
* `killed` boolean
Emitted 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. The `killed` boolean can be replaced by
checking `reason === 'killed'` when you switch to that event.
#### Event: 'render-process-gone'
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.
Emitted when the renderer process unexpectedly disappears. This is normally
because it was crashed or killed.

Except for the killed argument, which is not being forwarded:

crashed: [],
'render-process-gone': ['details'],

Also adds structures/render-process-gone-details.md to eliminate duplicates

Notes: none

@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes new-pr 🌱 PR opened in the last 24 hours labels Aug 14, 2023
@miniak miniak self-assigned this Aug 14, 2023
@miniak miniak added target/24-x-y PR should also be added to the "24-x-y" branch. target/25-x-y PR should also be added to the "25-x-y" branch. target/26-x-y PR should also be added to the "26-x-y" branch. labels Aug 14, 2023
@miniak miniak force-pushed the miniak/docs-webview-render-process-gone branch from 6c6f945 to fda5746 Compare August 14, 2023 19:46
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs: lgtm

Copy link

@electron-docs-reviewer electron-docs-reviewer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving on behalf of the Electron Docs Team

@miniak miniak force-pushed the miniak/docs-webview-render-process-gone branch from fda5746 to 22876ff Compare August 14, 2023 19:52
@miniak miniak changed the title docs: add mising webview 'render-process-gone' event docs: add missing webview render-process-gone event Aug 14, 2023
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Aug 15, 2023
@github-actions github-actions bot added the target/27-x-y PR should also be added to the "27-x-y" branch. label Aug 16, 2023
@miniak
Copy link
Contributor Author

miniak commented Aug 16, 2023

@zcbenz I think it can be merged now

@zcbenz zcbenz merged commit b04ce6a into main Aug 16, 2023
26 of 27 checks passed
@zcbenz zcbenz deleted the miniak/docs-webview-render-process-gone branch August 16, 2023 23:52
@release-clerk
Copy link

release-clerk bot commented Aug 16, 2023

No Release Notes

@trop
Copy link
Contributor

trop bot commented Aug 16, 2023

I have automatically backported this PR to "27-x-y", please check out #39543

@trop trop bot removed the target/27-x-y PR should also be added to the "27-x-y" branch. label Aug 16, 2023
@trop
Copy link
Contributor

trop bot commented Aug 16, 2023

I have automatically backported this PR to "24-x-y", please check out #39544

@trop
Copy link
Contributor

trop bot commented Aug 16, 2023

I have automatically backported this PR to "26-x-y", please check out #39545

@trop
Copy link
Contributor

trop bot commented Aug 16, 2023

I have automatically backported this PR to "25-x-y", please check out #39546

@trop trop bot added in-flight/26-x-y in-flight/25-x-y merged/25-x-y PR was merged to the "25-x-y" branch. merged/26-x-y PR was merged to the "26-x-y" branch. merged/24-x-y PR was merged to the "24-x-y" branch merged/27-x-y PR was merged to the "27-x-y" branch. and removed target/24-x-y PR should also be added to the "24-x-y" branch. target/26-x-y PR should also be added to the "26-x-y" branch. target/25-x-y PR should also be added to the "25-x-y" branch. in-flight/25-x-y in-flight/26-x-y in-flight/24-x-y in-flight/27-x-y labels Aug 16, 2023
win32ss pushed a commit to win32ss/supermium-electron that referenced this pull request Sep 24, 2023
docs: add mising webview 'render-process-gone' event
MrHuangJser pushed a commit to MrHuangJser/electron that referenced this pull request Dec 11, 2023
docs: add mising webview 'render-process-gone' event
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📓 merged/24-x-y PR was merged to the "24-x-y" branch merged/25-x-y PR was merged to the "25-x-y" branch. merged/26-x-y PR was merged to the "26-x-y" branch. merged/27-x-y PR was merged to the "27-x-y" branch. semver/patch backwards-compatible bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants