connect-bidi-web
    Preparing search index...

    Interface BidiWebSocketLike

    The subset of the Workers WebSocket interface that wrapWebSocket needs. Kept narrow and independent of @cloudflare/workers-types so it can be satisfied by a plain mock object in unit tests, while a real accepted Workers WebSocket also satisfies it structurally.

    interface BidiWebSocketLike {
        binaryType?: string;
        addEventListener(
            type: "message",
            listener: (event: { data: unknown }) => void,
        ): void;
        addEventListener(type: "close", listener: () => void): void;
        addEventListener(type: "error", listener: () => void): void;
        close(code?: number, reason?: string): void;
        send(
            message: string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
        ): void;
    }
    Index
    binaryType?
    addEventListener close send
    binaryType?: string

    Per the WebSocket spec this defaults to "blob", and workerd honors that default — wrapWebSocket sets it to "arraybuffer" when present, since the envelope parser needs bytes synchronously and cannot await Blob.arrayBuffer().

    • Parameters

      • type: "message"
      • listener: (event: { data: unknown }) => void

      Returns void

    • Parameters

      • type: "close"
      • listener: () => void

      Returns void

    • Parameters

      • type: "error"
      • listener: () => void

      Returns void

    • Parameters

      • message: string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods