[Flight] Add initial readme to react-server package #31464
Merged
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 ↗︎
|
rickhanlonii
approved these changes
Nov 8, 2024
| @@ -5,3 +5,216 @@ This is an experimental package for creating custom React streaming server rende | |||
| **Its API is not as stable as that of React, React Native, or React DOM, and does not follow the common versioning scheme.** | |||
|
|
|||
| **Use it at your own risk.** | |||
|
|
|||
| ## Usage | |||
There was a problem hiding this comment.
It would be cool to include a Reference section with the exports for flight and fizz (even with just the types).
There was a problem hiding this comment.
added a partial reference.
This readme documents React Server Components from `react-server` package enough to get an implementor started. It's not comphrensive but it's a beginning point and crucially adds documentation for the `prerender` API for Fligth.
edc8b8f
to
21a343b
Compare
sebmarkbage
reviewed
Nov 9, 2024
|
|
||
| ### `stopFlowing(request: Request): void` | ||
|
|
||
| If you need to pause or permanently end the writing of any additional serialized output for this request you can call `stopFlowing(request)`. You may start flowing again after you've stopped. This is how you would implement backpressure support for streams for instance. It's important to note that stopping flowing is not going to stop rendering it simply causes the request to buffer any serialized chunks until they are requested again with `startFlowing()`. |
There was a problem hiding this comment.
This is an implementation detail though. E.g. Fizz doesn't just simply buffer serialized chunks. It's likely Flight also would become more lazy in that regard.
There was a problem hiding this comment.
E.g. it would be the wrong take away that it would be better for a consumer to just manage its own buffer.
This was referenced Nov 11, 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.
This readme documents React Server Components from
react-serverpackage enough to get an implementer started. It's not comprehensive but it's a beginning point and crucially adds documentation for theprerenderAPI for Flight.