Skip to content

extend note about payload transfer differences between v1 and v2 #1438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
atilafassina wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Draft

extend note about payload transfer differences between v1 and v2 #1438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/routes/solid-start/advanced/serialization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,24 @@ SolidStart enables Seroval plus a default set of web platform plugins. These plu

Seroval supports additional value types. The compatibility list is broader than what SolidStart enables by default, so treat it as a superset. See the [Seroval compatibility docs](http://github.com/lxsmnsyc/seroval/blob/main/docs/COMPATIBILITY.md).

## Server function payloads (v1 vs v2)

SolidStart applies extra handling for certain payload types so file uploads and binary data can flow without being serialized by Seroval.

In v1, only `FormData` is treated this way, and only when it is the single argument passed to a server function. This allows file uploads to work without Seroval serialization.

In v2, this behavior is expanded and applies to both server function arguments and return values. SolidStart bypasses Seroval for:

- `FormData`
- `URLSearchParams`
- `Uint8Array`
- `ArrayBuffer`
- `Blob`
- `File`
- `string`

Because these values are transferred directly, v2 can yield smaller payloads for these cases.

## Limits and exclusions

- `RegExp` is disabled by default.
Expand Down