Skip to content

breaking: avoid flushing queued updates on mount/hydrate #12602

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 5 commits into from
Jul 25, 2024

Conversation

trueadm
Copy link
Contributor

@trueadm trueadm commented Jul 25, 2024

Attempt 2# at #12587. Fixes the SvelteKit issue by adding a flush_sync to the legacy wrapper.

Copy link

changeset-bot bot commented Jul 25, 2024

🦋 Changeset detected

Latest commit: 9b55af0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

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

@trueadm trueadm changed the title Revert "Revert "breaking: avoid flushing queued updates on mount/hydrate"" breaking: avoid flushing queued updates on mount/hydrate Jul 25, 2024
@trueadm trueadm marked this pull request as ready for review July 25, 2024 12:52
@dummdidumm
Copy link
Member

This also need updates to a few sections in the docs: The new documentation where the mount/hydrate APIs are mentioned, and the "breaking changes in runes mode" section

@Rich-Harris
Copy link
Member

I don't think we need to add anything in 'breaking changes in runes mode', mount and hydrate are brand new APIs and this change applies regardless of whether a given component is in runes mode

@Rich-Harris
Copy link
Member

I'll add some docs real quick, one sec

@@ -59,6 +61,8 @@ const app = hydrate(App, {
});
```

As with `mount`, effects will not run during `hydrate` — use `flushSync()` immediately afterwards if you need them to.
Copy link
Member

Choose a reason for hiding this comment

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

can you mirror that into the docs at documentation/...? because those are the soon-to-be final docs

@Rich-Harris Rich-Harris merged commit afa3128 into main Jul 25, 2024
7 of 9 checks passed
@Rich-Harris Rich-Harris deleted the revert-12593-revert-12587-no-flush-sync-init branch July 25, 2024 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants