Renaming SSR Callbacks #127

sebmarkbage · 2022-03-08T16:59:14Z

sebmarkbage
Mar 8, 2022
Maintainer

Heads up in the latest RC, we renamed some of the callbacks in the Node.js streaming API as well as the Web Streams API.

They're no longer called "Complete" but instead "Ready". That indicates that they're ready to be written but hasn't necessarily been written.

The Web Streams API have moved the onCompleteAll callback to a stream.allReady promise.

To wait for all Suspense boundaries to resolve before flushing:

let controller = new AbortController();
try {
  let stream = await renderToReadableStream(
    <html>
      <body>Success</body>
    </html>,
    {
      signal: controller.signal,
    }
  );
  await stream.allReady;
  return new Response(stream, {
    headers: {'Content-Type': 'text/html'},
  });
} catch (error) {
  return new Response(
    '<!doctype html><p>Loading...</p><script src="clientrender.js"></script>',
    {
      status: 500,
      headers: {'Content-Type': 'text/html'},
    }
  );
}

The Node.js API has onShellReady, onShellError or onAllReady callbacks.

const {pipe, abort} = renderToPipeableStream(
  <App />,
  {
    onAllReady() {
      res.statusCode = 200;
      res.setHeader('Content-type', 'text/html');
      pipe(res);
    },
    onShellError(x) {
      res.statusCode = 500;
      res.send(
        '<!doctype html><p>Loading...</p><script src="clientrender.js"></script>'
      );
    }
  }
);

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Renaming SSR Callbacks #127

{{title}}

Replies: 0 comments

Select a reply

Renaming SSR Callbacks #127

sebmarkbage Mar 8, 2022 Maintainer

Replies: 0 comments

sebmarkbage
Mar 8, 2022
Maintainer