Skip to content

Commit ebe5aee

Browse files
Copilothi-ogawa
andcommitted
docs: reference Vite Environment API for module runner transport
Add reference to Vite's official documentation on ModuleRunnerTransport pattern to clarify the server-side implementation approach. Co-authored-by: hi-ogawa <[email protected]>
1 parent fcc6cc0 commit ebe5aee

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/plugin-rsc/examples/browser-mode/vite.config.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,14 @@ import { createRequire } from 'node:module'
1616
const require = createRequire(import.meta.url)
1717

1818
/**
19-
* Create a WebSocket server transport for module runner communication
20-
* Similar to the client-side createWebSocketModuleRunnerTransport
19+
* Create a WebSocket server transport for module runner communication.
20+
*
21+
* This implements the server-side WebSocket pattern for module runner transport,
22+
* as documented in Vite's Environment API:
23+
* https://github.com/vitejs/vite/blob/main/docs/guide/api-environment-runtimes.md#modulerunnertransport
24+
*
25+
* The client uses `createWebSocketModuleRunnerTransport` with `connect/send`,
26+
* and this server handles WebSocket messages using the environment's `handleInvoke` method.
2127
*/
2228
function createWebSocketModuleRunnerServer(options: {
2329
server: ViteDevServer

0 commit comments

Comments
 (0)