@muspellheim/shared
    Preparing search index...

    Interface MessageClient

    An interface for a streaming message client.

    Emits the following events:

    It is used for wrappers around EventSource and WebSocket.

    interface MessageClient {
        get isConnected(): boolean;
        get url(): undefined | string;
        addEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        close(): Promise<void>;
        connect(url: string | URL): Promise<void>;
        dispatchEvent(event: Event): boolean;
        removeEventListener(
            type: string,
            callback: null | EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        send(message: string, type?: string): Promise<void>;
    }

    Hierarchy

    • EventTarget
      • MessageClient

    Implemented by

    Index

    Accessors

    isConnected url

    Methods

    addEventListener close connect dispatchEvent removeEventListener send

    Accessors

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: null | EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Send a message to the server.

      This is an optional method for streams with bidirectional communication.

      Parameters

      • message: string

        The message to send.

      • Optionaltype: string

        The optional message type.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods