Skip to content

Commit 2bed52c

Browse files
hi-ogawaOpenCode
andauthored
docs(plugin-rsc): align runtime API descriptions (#1286)
Co-authored-by: Hiroshi Ogawa <4232207+hi-ogawa@users.noreply.github.com> Co-authored-by: OpenCode <noreply@opencode.ai>
1 parent 85095b5 commit 2bed52c

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

packages/plugin-rsc/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -446,8 +446,8 @@ export default defineConfig({
446446

447447
### `@vitejs/plugin-rsc/rsc/server`
448448

449-
This module re-exports the server capabilities provided by
450-
`react-server-dom/server.edge`:
449+
This module provides Vite-integrated RSC runtime APIs based on
450+
`react-server-dom/server.edge` for use in the RSC environment:
451451

452452
- `renderToReadableStream`: RSC serialization (React VDOM -> RSC stream)
453453
- `decodeAction/decodeReply/decodeFormState/loadServerAction`
@@ -456,7 +456,7 @@ This module re-exports the server capabilities provided by
456456

457457
### `@vitejs/plugin-rsc/rsc/client`
458458

459-
This module re-exports the client protocol capabilities provided by
459+
This module provides Vite-integrated RSC runtime APIs based on
460460
`react-server-dom/client.edge` for use in the RSC environment:
461461

462462
- `createFromReadableStream`: RSC deserialization (RSC stream -> React VDOM)
@@ -496,15 +496,17 @@ function renderToReadableStream<T>(
496496

497497
### `@vitejs/plugin-rsc/ssr`
498498

499-
This module re-exports RSC runtime APIs provided by `react-server-dom/client.edge`:
499+
This module provides Vite-integrated RSC runtime APIs based on
500+
`react-server-dom/client.edge` for use in the SSR environment:
500501

501502
- `createFromReadableStream`: Deserializes an RSC stream into a React VDOM
502503
- `encodeReply`: Serializes server function arguments
503504
- `createTemporaryReferenceSet`: Creates a temporary reference set shared by deserialization and reply serialization
504505

505506
### `@vitejs/plugin-rsc/browser`
506507

507-
This module re-exports RSC runtime APIs provided by `react-server-dom/client.browser`:
508+
This module provides Vite-integrated RSC runtime APIs based on
509+
`react-server-dom/client.browser` for use in the browser environment:
508510

509511
- `createFromReadableStream`: Deserializes an RSC stream into a React VDOM
510512
- `createFromFetch`: Deserializes an RSC response from a fetch promise

0 commit comments

Comments
 (0)