From 4c65e3f04f045bd63848e074e978ce567a3086fd Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Sat, 26 Mar 2022 21:01:58 +0800 Subject: [PATCH] refactor: `onMessage` -> `onEvent` --- docs/guide/api-plugin.md | 4 ++-- packages/playground/hmr/vite.config.js | 2 +- packages/vite/src/node/server/ws.ts | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/guide/api-plugin.md b/docs/guide/api-plugin.md index 359309bcec68fd..010367d7cdb577 100644 --- 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 index 2b6c8f94b1badb..868d62aa8d681a 100644 --- 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 index 01318896d6af52..fa146f7eed5ccf 100644 --- 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(event: string, listener: WebSocketCustomListener): () => void + onEvent(event: string, listener: WebSocketCustomListener): () => void /** * Listen to raw events from the WebSocket server. * @advanced @@ -217,7 +217,7 @@ export function createWebSocketServer( }) }, - onMessage(event: string, listener: WebSocketCustomListener) { + onEvent(event: string, listener: WebSocketCustomListener) { if (!customListeners.has(event)) customListeners.set(event, new Set()) customListeners.get(event)!.add(listener)