docs(react-start): serialization adapters
Added an example on how to add serialization adapters for React Start. Not 100% sure if the right place is in the server function docs. LMK otherwise!
Summary by CodeRabbit
- Documentation
- Added a comprehensive "Custom serialization adapters" guide with a complete example (includes a bigint adapter) for handling complex types.
- Guide published in both React and Solid server-functions guides; the React guide includes the new section in two locations for easier discovery.
- No changes to public APIs or declarations.
✏️ Tip: You can customize this high-level summary in your review settings.
Walkthrough
Adds a new "Custom serialization adapters" documentation section to the Server Functions guides for React and Solid, including a TypeScript bigint adapter example; the React guide contains the same section inserted twice. No public API or exported declarations were changed.
Changes
| Cohort / File(s) | Summary |
|---|---|
Server Functions documentation — React docs/start/framework/react/guide/server-functions.md |
Inserted a "Custom serialization adapters" section (TypeScript bigint adapter example) in two locations within the guide; shows how to create an adapter with createSerializationAdapter and register it via start configuration. |
Server Functions documentation — Solid docs/start/framework/solid/guide/server-functions.md |
Added a "Custom serialization adapters" section with a TypeScript bigint adapter example and instructions to register the adapter via the start configuration. |
Sequence Diagram(s)
(Not applicable — documentation-only changes; no control-flow or runtime behavior changes to diagram.)
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~5 minutes
- Verify whether the duplicated section in
docs/start/framework/react/guide/server-functions.mdis intentional or should be consolidated.
Possibly related PRs
- TanStack/router#5321 — integrates merging of
serializationAdaptersfrom multiple sources so custom adapters documented here are preserved and combined at runtime.
Poem
🐇 I nibble docs by lantern-light,
I teach bigints to take their flight,
Two pages hum the same small song,
A tiny adapter hopping along.
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title 'docs(react-start): serialization adapters' clearly and concisely identifies the primary change—adding documentation about serialization adapters to the React Start guide. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✨ Finishing touches
🧪 Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
📜 Recent review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 9503de0623334187de8f44d301cb59a656c137b9 and 02f14390b322e89fc7ac476e3d5c3182ce913547.
📒 Files selected for processing (1)
docs/start/framework/solid/guide/server-functions.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/start/framework/solid/guide/server-functions.md
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
@m9tdev can you add the same to the solid docs so they stay in sync?
we need to document serialization adapters more generally, not just for server functions. they apply for beforeLoad and loader as well. a separate doc page should be added for this. want to do this when i find the time :)
@birkskyum Should they be the same for Solid? I have no experience with Solid, but if they are the same I'll add them!
@schiller-manuel Maybe we can add this in the meantime to save others some time when looking for it.
View your CI Pipeline Execution ↗ for commit 86875e673a0376f50fc8923ee249f0b06f81ed7b
| Command | Status | Duration | Result |
|---|---|---|---|
nx affected --targets=test:eslint,test:unit,tes... |
✅ Succeeded | <1s | View ↗ |
nx run-many --target=build --exclude=examples/*... |
✅ Succeeded | 2s | View ↗ |
☁️ Nx Cloud last updated this comment at 2025-11-18 10:43:12 UTC
Yes it's the same for solid, except for the package name being solid-start
@birkskyum done! There was nothing in there yet (except some frontmatter), but I've added it for Solid.