Interface HMRChannel

name

close

• close(): void

• Disconnect all clients, called when server is closed or restarted.

  Returns void

listen

• listen(): void

• Start listening for messages

  Returns void

off

• off(event, listener): void

• Unregister event listener

  Parameters

  • event: string
  • listener: Function

  Returns void

on

• on<T>(event, listener): void

• Handle custom event emitted by import.meta.hot.send

  Type Parameters

  • T extends string

  Parameters

  • event: T
  • listener: ((data, client, ...args) => void)
    • • (data, client, ...args): void

      • Parameters

        • data: InferCustomEventPayload<T>
        • client: HMRBroadcasterClient
        • Rest ...args: any[]

        Returns void

  Returns void
• on(event, listener): void

• Parameters

  • event: "connection"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns void

send

• send(payload): void

• Broadcast events to all clients

  Parameters

  • payload: HMRPayload

  Returns void
• send<T>(event, payload?): void

• Send custom event

  Type Parameters

  • T extends string

  Parameters

  • event: T
  • Optional payload: InferCustomEventPayload<T>

  Returns void