WebSocket.binaryType

The WebSocket.binaryType property controls the type of binary data being received over the WebSocket connection.

Syntax

var binaryType = aWebSocket.binaryType;

Value

A DOMString:

"blob"
Use Blob objects for binary data. This is the default value.
"arraybuffer"
Use ArrayBuffer objects for binary data.

Examples

// Create WebSocket connection.
const socket = new WebSocket("ws://localhost:8080");
// Change binary type from "blob" to "arraybuffer"
socket.binaryType = "arraybuffer";

// Listen for messages
socket.addEventListener("message", function (event) {
    if(event.data instanceof ArrayBuffer) {
        // binary frame
        const view = new DataView(event.data);
        console.log(view.getInt32(0));
    } else {
        // text frame
        console.log(event.data);
    }
});

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'WebSocket: binaryType' in that specification.
Living Standard Initial definition

Browser compatibility

BCD tables only load in the browser