Merged
Conversation
Add signalReady() and waitForReady() methods so consumers don't need to build their own ready handshake pattern for srcdoc iframes. - signalReady(): registers a __framecast_ready function handler and proactively broadcasts a ready message - waitForReady(): polls via function calls and listens for broadcast, resolving when either succeeds. Supports configurable interval and timeout. Linear-issue: CON-6607
🦋 Changeset detectedLatest commit: 7648b6d The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
karngyan
approved these changes
Mar 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every consumer of framecast that uses srcdoc iframes needs to build their own ready handshake — the parent needs to know when the iframe's script has set up its framecast listener before sending messages. This PR adds built-in support so consumers don't have to reinvent this pattern.
Changes
Adds two new methods to the
Framecastclass:signalReady()(iframe side)__framecast_readyfunction handler that responds withtrue{ type: '__framecast_ready' }messagewaitForReady(options?)(parent side)Promise<void>that resolves when the other side is ready__framecast_readyfunction at a configurable interval (default 50ms)interval(default 50ms),timeout(default 10s, 0 to disable)Tests
7 new tests covering:
signalReadyregisters handler and broadcastssignalReadyresponds to ready-check function callswaitForReadyresolves on broadcastwaitForReadyresolves on successful function call pollwaitForReadytimes out correctlywaitForReadywithtimeout: 0never times outLinear-issue: CON-6607