Interface NormalizedHotChannel<Api>

Optionalapi

close

• close(): void | Promise<unknown>

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

  Returns void | Promise<unknown>

handleInvoke

• handleInvoke(payload: HotPayload): Promise<{ result: any } | { error: any }>

  Parameters

  • payload: HotPayload

  Returns Promise<{ result: any } | { error: any }>

listen

• listen(): void

  Start listening for messages

  Returns void

off

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

  Unregister event listener

  Parameters

  • event: string
  • listener: Function

  Returns void

on

• on<T extends string>(
      event: T,
      listener: (
          data: InferCustomEventPayload<T>,
          client: NormalizedHotChannelClient,
      ) => void,
  ): void

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

  Type Parameters

  • T extends string

  Parameters

  • event: T
  • listener: (data: InferCustomEventPayload<T>, client: NormalizedHotChannelClient) => void

  Returns void

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

  Parameters

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

  Returns void

  Deprecated

  use vite:client:connect event instead

send

• send(payload: HotPayload): void

  Broadcast events to all clients

  Parameters

  • payload: HotPayload

  Returns void

• send<T extends string>(event: T, payload?: InferCustomEventPayload<T>): void

  Send custom event

  Type Parameters

  • T extends string

  Parameters

  • event: T
  • Optionalpayload: InferCustomEventPayload<T>

  Returns void