@squawk
    Preparing search index...

    Interface BeastStream

    A live client for a Beast-format TCP feed. Dispatches beast:message (carrying BeastMessageEventDetail) for every deframed frame, beast:frameError (carrying BeastFrameErrorEventDetail) for framing or decode problems, and beast:connect / beast:disconnect (carrying BeastConnectEventDetail / BeastDisconnectEventDetail) for connection lifecycle.

    Create one with createBeastStream rather than implementing this interface directly.

    interface BeastStream {
        addEventListener(
            type: string,
            listener: EventListener | EventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        removeEventListener(
            type: string,
            listener: EventListener | EventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        start(): void;
        stop(): void;
    }

    Hierarchy

    • EventTarget
      • BeastStream
    Index
    addEventListener dispatchEvent removeEventListener start stop

    • Parameters

      • type: string
      • listener: EventListener | EventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • event: Event

      Returns boolean

    • Parameters

      • type: string
      • listener: EventListener | EventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods