Interface HMRBroadcaster

Construct a type with the properties of T except for those in type K.

interface HMRBroadcaster {
    channels: HMRChannel[];
    addChannel(connection): HMRBroadcaster;
    close(): Promise<unknown[]>;
    listen(): void;
    off(event, listener): void;
    on<T>(event, listener): void;
    on(event, listener): void;
    send(payload): void;
    send<T>(event, payload?): void;
}

Hierarchy (view full)

Properties

channels

Methods

addChannel close listen off on send

Properties

Readonly channels

channels: HMRChannel[]

All registered channels. Always has websocket channel.

Methods

addChannel

close

  • close(): Promise<unknown[]>

  • Returns Promise<unknown[]>

listen

  • listen(): void

  • Start listening for messages

    Returns void

off

  • off(event, listener): void

  • Unregister event listener

    Parameters

    Returns void

on

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

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

    Type Parameters

    • T extends string

    Parameters

    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

    Returns void

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

  • Send custom event

    Type Parameters

    • T extends string

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

channelsaddChannelcloselistenoffonsend