Appearance

WebSocket ​

WebSocket connection for real-time communication

Example:

javascript
var ws = websocket.connect('wss://api.example.com/ws', {
    headers: { 'Authorization': 'Bearer token' }
});

ws.onOpen = function() {
    console.log('Connected');
    ws.send(JSON.stringify({ type: 'hello' }));
};

ws.onMessage = function(event) {
    var data = JSON.parse(event.data);
    console.log('Received:', data);
};

ws.onError = function(event) {
    console.error('Error:', event.error);
};

ws.onClose = function() {
    console.log('Disconnected');
};

// Later...
ws.close();

Properties ​

onClose ​

  • Type: any
  • Called when connection closes

onError ​

  • Type: any
  • Called on error (event.error contains the Error)

onMessage ​

  • Type: any
  • Called when message received (event.data contains the message)

onOpen ​

  • Type: any
  • Called when connection opens

Methods ​

close() ​

javascript
close(): void

Close the connection

Returns: void

send() ​

javascript
send(message: string): void

Send a message

Parameters:

  • message (string) - String message to send

Returns: void