papi-dts
    Preparing search index...

    Class PapiRendererWebSocket

    This wraps the browser's WebSocket implementation to provide better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

    Note that the Node WebSocket implementation is different and not wrapped here.

    Implements

    • WebSocket
    Index

    Constructors

    constructor

    Properties

    addEventListener binaryType bufferedAmount close CLOSED CLOSING CONNECTING dispatchEvent extensions onclose onerror onmessage onopen OPEN protocol readyState removeEventListener send url

    Constructors

    Properties

    addEventListener: <K extends keyof WebSocketEventMap>(
        type: K,
        listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ) => void
    binaryType: BinaryType

    Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

    Can be set, to change how binary data is returned. The default is "blob".

    MDN Reference

    bufferedAmount: number

    Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

    If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)

    MDN Reference

    close: (code?: number, reason?: string) => void

    Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

    MDN Reference

    CLOSED: 3
    CLOSING: 2
    CONNECTING: 0
    dispatchEvent: (event: Event) => boolean

    Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    extensions: string

    Returns the extensions selected by the server, if any.

    MDN Reference

    onclose: null | ((this: WebSocket, ev: CloseEvent) => any)

    MDN Reference

    onerror: null | ((this: WebSocket, ev: Event) => any)

    MDN Reference

    onmessage: null | ((this: WebSocket, ev: MessageEvent) => any)

    MDN Reference

    onopen: null | ((this: WebSocket, ev: Event) => any)

    MDN Reference

    OPEN: 1
    protocol: string

    Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

    MDN Reference

    readyState: number

    Returns the state of the WebSocket object's connection. It can have the values described below.

    MDN Reference

    removeEventListener: <K extends keyof WebSocketEventMap>(
        type: K,
        listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ) => void
    send: (data: string | ArrayBufferLike | ArrayBufferView | Blob) => void

    Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

    MDN Reference

    url: string

    Returns the URL that was used to establish the WebSocket connection.

    MDN Reference

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties