[Flight] rename prerender to unstable_prerender and include in stable channel
#31724
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
facebook-github-bot
added
the
React Core Team
sebmarkbage
reviewed
Dec 10, 2024
| @@ -10,3 +10,6 @@ if (process.env.NODE_ENV === 'production') { | |||
| if (s.prerenderToNodeStream) { | |||
| exports.prerenderToNodeStream = s.prerenderToNodeStream; | |||
| } | |||
sebmarkbage
approved these changes
Dec 10, 2024
gnoff
force-pushed
the
add-unstable-prerender-flight
branch
from
5252edb to
1c928f2
Compare
gnoff
changed the title
unstable_prerender to stable builds
gnoff
changed the title
prerender to unstable_prerender and include in stable channel
gnoff
force-pushed
the
add-unstable-prerender-flight
branch
2 times, most recently
from
9181778 to
f5b04e7
Compare
…able channel We added an experimental `prerender` API to flight. This change exposes this API in stable channels prefixed as `unstable_prerender`. We have high confidence this API should exist but because we have not yet settled on how to handle resuming/replaying of RSC streams we may need to change the API contract to suit future needs. This release will allow us to get more usage out of the existing implemented functionality without requiring you to use experimental builds which will open up greater adoption and opportunity for feedback. the `prerender` implementation is documented in the `react-server` package. As with all RSC APIs implemented in bundler specific binding packages these aren't inteded to be called by end users but instead be used by frameworks implementing React Server Components. Previously `prerender` was exposed unprefixed and only in the experimental channel. This PR renames the export across all channels to `unstable_prerender` so users of this previously unprefixed api will need to update to the unstable form. This isn't a breaking change because it was only exposed in the experimental channel which does not follow semver. The reason we don't expose it under both names is that users may feature detect the unprefixed form and then when we finally do ship it as unprefixed we may change the function signature and break this code. Changing the name now is much safer.
gnoff
force-pushed
the
add-unstable-prerender-flight
branch
from
f5b04e7 to
8e2dbfb
Compare
This was referenced Dec 18, 2024
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.
We added an experimental
prerenderAPI to flight. This change exposes this API in stable channels prefixed asunstable_prerender. We have high confidence this API should exist but because we have not yet settled on how to handle resuming/replaying of RSC streams we may need to change the API contract to suit future needs. This release will allow us to get more usage out of the existing implemented functionality without requiring you to use experimental builds which will open up greater adoption and opportunity for feedback.the
prerenderimplementation is documented in thereact-serverpackage. As with all RSC APIs implemented in bundler specific binding packages these aren't intended to be called by end users but instead be used by frameworks implementing React Server Components.Previously
prerenderwas exposed unprefixed and only in the experimental channel. This PR renames the export across all channels tounstable_prerenderso users of this previously unprefixed api will need to update to the unstable form. This isn't a breaking change because it was only exposed in the experimental channel which does not follow semver. The reason we don't expose it under both names is that users may feature detect the unprefixed form and then when we finally do ship it as unprefixed we may change the function signature and break this code. Changing the name now is much safer.