refactor: onMessage -> onEvent

vitejs · Mar 26, 2022 · 4c65e3f · 4c65e3f
1 parent bf2acd9
commit 4c65e3f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/guide/api-plugin.md b/docs/guide/api-plugin.md
@@ -544,7 +544,7 @@ if (import.meta.hot) {
 }
 ```
 
-On the plugin side, we can use `server.ws.onMessage` listening to the events:
+On the plugin side, we can use `server.ws.onEvent` listening to the events:
 
 ```js
 // vite.config.js
@@ -553,7 +553,7 @@ export default defineConfig({
     {
       // ...
       configureServer(server) {
-        server.ws.onMessage('from-client', (data, client) => {
+        server.ws.onEvent('from-client', (data, client) => {
           console.log('Message from client:', data.msg) // Hey!
           // reply only to the client (if needed)
           client.send({

diff --git a/packages/playground/hmr/vite.config.js b/packages/playground/hmr/vite.config.js
@@ -19,7 +19,7 @@ module.exports = {
         }
       },
       configureServer(server) {
-        server.ws.onMessage('remote-add', ({ a, b }, client) => {
+        server.ws.onEvent('remote-add', ({ a, b }, client) => {
           client.send({
             type: 'custom',
             event: 'remote-add-result',

diff --git a/packages/vite/src/node/server/ws.ts b/packages/vite/src/node/server/ws.ts
@@ -32,7 +32,7 @@ export interface WebSocketServer {
   /**
    * Handle custom event emitted by `import.meta.hot.send`
    */
-  onMessage<T>(event: string, listener: WebSocketCustomListener<T>): () => void
+  onEvent<T>(event: string, listener: WebSocketCustomListener<T>): () => void
   /**
    * Listen to raw events from the WebSocket server.
    * @advanced
@@ -217,7 +217,7 @@ export function createWebSocketServer(
       })
     },
 
-    onMessage<T>(event: string, listener: WebSocketCustomListener<T>) {
+    onEvent<T>(event: string, listener: WebSocketCustomListener<T>) {
       if (!customListeners.has(event)) customListeners.set(event, new Set())
       customListeners.get(event)!.add(listener)