WebSocket Class

Warning: Macros that reference WebSocket are blocked on macro sharing. Remove WebSocket.connect(...) and socket messaging before sharing the macro. WebSocket creates a persistent connection to a WebSocket server.

`WebSocket.connect(url, onMessage, onError)`

Open a connection and create a client object.

let socket = WebSocket.connect('wss://example.com/live', function (message) {
  console.log(message);
}, function (error) {
  console.error(error);
});
console.log(socket.isConnected());

`socket.send(message)`

Send one message.

let socket = WebSocket.connect('wss://example.com/live', function (message) {
  console.log(message);
}, function (error) {
  console.error(error);
});
socket.send('{"type":"ping"}');

`socket.readMessage()`

Read the next message received from the server (returns null if none).

let socket = WebSocket.connect('wss://example.com/live', function (message) {
  console.log(message);
}, function (error) {
  console.error(error);
});
let result = socket.readMessage();
console.log(result);

`socket.close()`

Close the connection.

let socket = WebSocket.connect('wss://example.com/live', function (message) {
  console.log(message);
}, function (error) {
  console.error(error);
});
socket.close();

`socket.isConnected()`

Check whether the client still has a connection object.

let socket = WebSocket.connect('wss://example.com/live', function (message) {
  console.log(message);
}, function (error) {
  console.error(error);
});
let result = socket.isConnected();
console.log(result);

`WebSocket.closeAll()`

Close all active socket connections.

let socket = WebSocket.connect('wss://example.com/live', function (message) {
  console.log(message);
}, function (error) {
  console.error(error);
});
WebSocket.closeAll();