Skip to content

docs: document start.renderMode in the StartOptions reference - #1715

Open
VedangP57 wants to merge 1 commit into
solidjs:v2-rebuildfrom
VedangP57:docs/start-render-mode-reference
Open

VedangP57 wants to merge 1 commit into
solidjs:v2-rebuildfrom
VedangP57:docs/start-render-mode-reference

Conversation

@VedangP57

Copy link
Copy Markdown
  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

The StartOptions reference lists renderMode?: "stream" | "async" in its type but has no section for it, unlike the options around it. This adds one, based on the renderMode section of the @solidjs/vite-plugin 3.0.1 README:

  • what "stream" and "async" each send, and that a client without JavaScript sees the Loading fallbacks under "stream";
  • the costs of "async" (first byte waits for the slowest boundary, whole page buffered, deferStream moot, a mid-render Location becomes a real 3xx);
  • per-request choice with event.renderMode in middleware, the handleRequest(request, { renderMode }) host option, and their precedence;
  • that it has no effect in client mode.

Checked: prettier --check, pnpm lint:tone (0 errors), pnpm check:types. Rendered the page with vite dev: the section shows with id="rendermode" and the #middleware link resolves.

Related issues & labels

🤖 Generated with Claude Code

@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify

netlify Bot commented Nov 19, 2026

Copy link
Copy Markdown

👷 Deploy request for solid-docs-v2 pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 75a6b39

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant