-
-
Notifications
You must be signed in to change notification settings - Fork 100
Add streaming to readme #448
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
+98
−0
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -144,6 +144,104 @@ main().catch((error) => { | |
|
|
||
| --- | ||
|
|
||
| ### Streaming | ||
|
|
||
| > [!NOTE] | ||
| > This is an early version of our streaming implementation. | ||
|
|
||
| Preact supports streaming HTML to the client incrementally, flushing `<Suspense>` fallbacks immediately and replacing them with the resolved content as data arrives. This reduces Time to First Byte and allows the browser to start parsing earlier. | ||
|
|
||
| #### `renderToReadableStream` — Web Streams (Edge / Deno / Bun / Cloudflare Workers) | ||
|
|
||
| ```jsx | ||
| import { renderToReadableStream } from 'preact-render-to-string/stream'; | ||
| import { Suspense, lazy } from 'preact/compat'; | ||
|
|
||
| const Profile = lazy(() => import('./Profile')); | ||
|
|
||
| const App = () => ( | ||
| <html> | ||
| <head><title>My App</title></head> | ||
| <body> | ||
| <Suspense fallback={<p>Loading profile…</p>}> | ||
| <Profile /> | ||
| </Suspense> | ||
| </body> | ||
| </html> | ||
| ); | ||
|
|
||
| // Works in any Web Streams environment (Deno, Bun, Cloudflare Workers, …) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably want to mirror here too then Edit: oops, I was late |
||
| export default { | ||
| fetch() { | ||
| const stream = renderToReadableStream(<App />); | ||
|
|
||
| // stream.allReady resolves once all suspended content has been flushed | ||
| return new Response(stream, { | ||
| headers: { 'Content-Type': 'text/html' } | ||
| }); | ||
| } | ||
| }; | ||
| ``` | ||
|
|
||
| The returned `ReadableStream` has an extra `allReady: Promise<void>` property that resolves once every suspended subtree has been written. Await it before sending the response if you need the complete document before anything is flushed (e.g. for static export). At which point you might be better off using `renderToStringAsync` though. | ||
|
|
||
| ```js | ||
| const stream = renderToReadableStream(<App />); | ||
| await stream.allReady; // wait for full render | ||
| ``` | ||
|
|
||
| #### `renderToPipeableStream` — Node.js Streams | ||
|
|
||
| ```jsx | ||
| import { createServer } from 'node:http'; | ||
| import { renderToPipeableStream } from 'preact-render-to-string/stream-node'; | ||
| import { Suspense, lazy } from 'preact/compat'; | ||
|
|
||
| const Profile = lazy(() => import('./Profile')); | ||
|
|
||
| const App = () => ( | ||
| <html> | ||
| <head><title>My App</title></head> | ||
| <body> | ||
| <Suspense fallback={<p>Loading profile…</p>}> | ||
| <Profile /> | ||
| </Suspense> | ||
| </body> | ||
| </html> | ||
| ); | ||
|
|
||
| createServer((req, res) => { | ||
| res.setHeader('Content-Type', 'text/html'); | ||
|
|
||
| const { pipe, abort } = renderToPipeableStream(<App />, { | ||
| onShellReady() { | ||
| // Called once the synchronous shell is ready to stream. | ||
| pipe(res); | ||
| }, | ||
| onAllReady() { | ||
| // Called once every suspended subtree has been flushed. | ||
| }, | ||
| onError(error) { | ||
| console.error(error); | ||
| res.statusCode = 500; | ||
| } | ||
| }); | ||
|
|
||
| // Optional: abort the render after a timeout | ||
| setTimeout(abort, 10_000); | ||
| }).listen(8080); | ||
| ``` | ||
|
|
||
| | Option | Description | | ||
| |---|---| | ||
| | `onShellReady()` | Called synchronously once the initial shell has been rendered and streaming is about to start. Pipe here for fastest TTFB. | | ||
| | `onAllReady()` | Called after all `<Suspense>` boundaries have resolved and the stream is complete. | | ||
| | `onError(error)` | Called for render errors inside suspended subtrees. | | ||
|
|
||
| Calling `abort()` stops the render and destroys the stream; any pending suspended subtrees are dropped. | ||
|
|
||
| --- | ||
|
|
||
| ### License | ||
|
|
||
| [MIT](http://choosealicense.com/licenses/mit/) | ||
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.
Uh oh!
There was an error while loading. Please reload this page.