Interface HotChannel<Api>

Optionalapi

Optionalclose

• close?(): void | Promise<unknown>

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

  Returns void | Promise<unknown>

Optionallisten

• listen?(): void

  Start listening for messages

  Returns void

Optionaloff

• off?(event: string, listener: Function): void

  Unregister event listener

  Parameters

  • event: string
  • listener: Function

  Returns void

Optionalon

• on?<T extends string>(event: T, listener: HotChannelListener<T>): void

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

  Type Parameters

  • T extends string

  Parameters

  • event: T
  • listener: HotChannelListener<T>

  Returns void

• on?(event: "connection", listener: () => void): void

  Parameters

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

  Returns void

Optionalsend

• send?(payload: HotPayload): void

  Broadcast events to all clients

  Parameters

  • payload: HotPayload

  Returns void