Skip to content

Improve description of "broadcastchannel-message" bfcache blocking reason #40487

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

Merged
merged 3 commits into from
Jul 22, 2025

Conversation

westonruter
Copy link
Contributor

Description

The message event being referenced is not using code formatting and it isn't linking to the MessageEvent docs. This PR adds the formatting and add the link.

Motivation

Formatting the message event and adding a link to improve readability and discoverability.

@westonruter westonruter requested a review from a team as a code owner July 21, 2025 23:12
@westonruter westonruter requested review from sideshowbarker and removed request for a team July 21, 2025 23:12
@github-actions github-actions bot added Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed labels Jul 21, 2025
…g_reasons/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@sideshowbarker sideshowbarker merged commit 1f3bed5 into mdn:main Jul 22, 2025
8 checks passed
@sideshowbarker
Copy link
Member

Weston, 👍 and congrats on landing your first docs change here — welcome aboard 🎉

@@ -171,7 +171,7 @@ Additional blocking reasons that may be used by some browsers are also specified
- `"background-work"`
- : The Document requested background work by calling [`SyncManager`](/en-US/docs/Web/API/SyncManager)'s [`register()`](/en-US/docs/Web/API/SyncManager/register) method, [`PeriodicSyncManager`](/en-US/docs/Web/API/PeriodicSyncManager)'s [`register()`](/en-US/docs/Web/API/PeriodicSyncManager/register) method, or [`BackgroundFetchManager`](/en-US/docs/Web/API/BackgroundFetchManager)'s [`fetch()`](/en-US/docs/Web/API/BackgroundFetchManager/fetch) method.
- `"broadcastchannel-message"`
- : While the page was stored in back/forward cache, a [`BroadcastChannel`](/en-US/docs/Web/API/BroadcastChannel) connection on the page received a message and message event was fired.
- : While the page was stored in back/forward cache, a [`BroadcastChannel`](/en-US/docs/Web/API/BroadcastChannel) connection on the page received a message to trigger a [`message`](/en-US/docs/Web/API/MessageEvent) event.
Copy link
Member

Choose a reason for hiding this comment

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

Just want to point out that https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/message_event would be a better target, because MessageEvent is too generic. Not important enough to fix though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants