A11 TypeScript API - v0.2.1
    Preparing search index...

    Interface WebSocketLike

    Minimum browser/ws socket surface required by the A11 adapter.

    interface WebSocketLike {
        binaryType: string;
        bufferedAmount: number;
        readyState: number;
        addEventListener(
            type: "error" | "message" | "open" | "close",
            listener: (event: WebSocketEventLike) => void,
        ): void;
        close(code?: number, reason?: string): void;
        send(data: string | Uint8Array<ArrayBufferLike>): void;
    }
    Index
    binaryType bufferedAmount readyState
    addEventListener close send
    binaryType: string

    Requested representation for inbound binary messages.

    bufferedAmount: number

    Bytes accepted by send but not yet transmitted.

    readyState: number

    Native WebSocket ready-state value.

    • Subscribe to transport lifecycle events.

      Parameters

      • type: "error" | "message" | "open" | "close"
      • listener: (event: WebSocketEventLike) => void

      Returns void

    • Close the underlying WebSocket.

      Parameters

      • Optionalcode: number
      • Optionalreason: string

      Returns void

    • Queue one binary packet (or signalling string for shared factories).

      Parameters

      • data: string | Uint8Array<ArrayBufferLike>

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods