renderToPipeableStream

Call renderToPipeableStream with the complete React document and optional callbacks, then pipe the returned output into a Writable Node.js stream. Start in onShellReady for progressive streaming, use onAllReady for crawlers or static generation, and abort when rendering should stop.

const { pipe, abort } = renderToPipeableStream(reactNode, options?)

An object containing pipe, which writes HTML to a Writable Node.js Stream, and abort, which stops server rendering and allows the remaining UI to render on the client.

import { renderToPipeableStream } from 'react-dom/server';

export function handleRequest(request, response) {
  const { pipe, abort } = renderToPipeableStream(<App />, {
    bootstrapScripts: ['/main.js'],
    onShellReady() {
      response.statusCode = 200;
      response.setHeader('content-type', 'text/html');
      pipe(response);
    },
    onShellError(error) {
      console.error(error);
      response.statusCode = 500;
      response.end('Server error');
    },
  });

  request.on('close', abort);
}

function App() {
  return <html><body><h1>Hello</h1></body></html>;
}

Creates a Node.js streaming response, starts piping when the shell is ready, and aborts rendering if the request closes.