createServerHotChannel() — vite Function Reference

Architecture documentation for the createServerHotChannel() function in hmr.ts from the vite codebase.

Function typescript ViteCore ConfigEngine calls 2 called by 1

Entity Profile

ViteCore→ ConfigEngine→ createServerHotChannel() — vite Function Reference

Dependency Diagram

graph TD
  3ae37b09_9e5f_0382_d4ac_99a73ab344c3["createServerHotChannel()"]
  18db4f26_79f1_5b7d_b291_4feeaf95538f["hmr.ts"]
  3ae37b09_9e5f_0382_d4ac_99a73ab344c3 -->|defined in| 18db4f26_79f1_5b7d_b291_4feeaf95538f
  197f4a26_efd8_e49d_88ae_a9f5707d4b33["createRunnableDevEnvironment()"]
  197f4a26_efd8_e49d_88ae_a9f5707d4b33 -->|calls| 3ae37b09_9e5f_0382_d4ac_99a73ab344c3
  0edbbec3_6066_80b2_5f47_367d86a7705f["listen()"]
  3ae37b09_9e5f_0382_d4ac_99a73ab344c3 -->|calls| 0edbbec3_6066_80b2_5f47_367d86a7705f
  2a568e89_e3e7_9284_fd00_e1a9ca1ec09a["close()"]
  3ae37b09_9e5f_0382_d4ac_99a73ab344c3 -->|calls| 2a568e89_e3e7_9284_fd00_e1a9ca1ec09a
  style 3ae37b09_9e5f_0382_d4ac_99a73ab344c3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/vite/src/node/server/hmr.ts lines 1121–1147

export function createServerHotChannel(): ServerHotChannel {
  const innerEmitter = new EventEmitter()
  const outsideEmitter = new EventEmitter()

  return {
    send(payload: HotPayload) {
      outsideEmitter.emit('send', payload)
    },
    off(event, listener: () => void) {
      innerEmitter.off(event, listener)
    },
    on: ((event: string, listener: () => unknown) => {
      innerEmitter.on(event, listener)
    }) as ServerHotChannel['on'],
    close() {
      innerEmitter.removeAllListeners()
      outsideEmitter.removeAllListeners()
    },
    listen() {
      innerEmitter.emit('connection')
    },
    api: {
      innerEmitter,
      outsideEmitter,
    },
  }
}