[Bug]: `importMap` option on `renderTo{Pipeable|Readable}Stream` is undocumented
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Summary
importMap option is not documented on either page for renderToPipeableStream nor renderToReadableStream
Page
https://react.dev/reference/react-dom/server/renderToReadableStream
Details
After spending a decent amount of time trying to figure out how to inject an importMap when server rendering within React, I finally stumbled across the fixtures which showcase using the importMap option. I have found no reference to this option on the current docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the renderToReadableStream page and the corresponding renderToPipeableStream documentation, then inspect the linked fixtures/flight-esm/server/global.js example around the importMap option. Document the option on both pages, including how it is used, and verify that each page now references it clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100