fix: make result interfaces for ModuleRunnerTransport#invoke more e…

…xplicit (#18851)
vitejs · Dec 2, 2024 · a75fc31 · a75fc31
1 parent 44a0f40
commit a75fc31
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 9 deletions.
diff --git a/docs/guide/api-environment-runtimes.md b/docs/guide/api-environment-runtimes.md
@@ -265,9 +265,7 @@ interface ModuleRunnerTransport {
   connect?(handlers: ModuleRunnerTransportHandlers): Promise<void> | void
   disconnect?(): Promise<void> | void
   send?(data: HotPayload): Promise<void> | void
-  invoke?(
-    data: HotPayload,
-  ): Promise<{ /** result */ r: any } | { /** error */ e: any }>
+  invoke?(data: HotPayload): Promise<{ result: any } | { error: any }>
   timeout?: number
 }
 ```

diff --git a/packages/vite/src/shared/moduleRunnerTransport.ts b/packages/vite/src/shared/moduleRunnerTransport.ts
@@ -19,9 +19,7 @@ export interface ModuleRunnerTransport {
   connect?(handlers: ModuleRunnerTransportHandlers): Promise<void> | void
   disconnect?(): Promise<void> | void
   send?(data: HotPayload): Promise<void> | void
-  invoke?(
-    data: HotPayload,
-  ): Promise<{ /** result */ r: any } | { /** error */ e: any }>
+  invoke?(data: HotPayload): Promise<{ result: any } | { error: any }>
   timeout?: number
 }
 
@@ -58,10 +56,10 @@ const createInvokeableTransport = (
             data,
           } satisfies InvokeSendData,
         } satisfies CustomPayload)
-        if ('e' in result) {
-          throw reviveInvokeError(result.e)
+        if ('error' in result) {
+          throw reviveInvokeError(result.error)
         }
-        return result.r
+        return result.result
       },
     }
   }