websocket-async

Table of Contents

• WebSocketClient
  • connected
  • dataAvailable
  • connect
  • send
  • receive
  • disconnect

WebSocketClient

An asynchronous WebSocket client.

Examples

// Set up connection.
const webSocketClient = new WebSocketClient;
// Connect.
await webSocketClient.connect('ws://www.example.com/');
// Send is synchronous.
webSocketClient.send('Hello!');
// Receive is asynchronous.
console.log(await webSocketClient.receive());
// See if there are any more messages received.
if (webSocketClient.dataAvailable !== 0) {
    console.log(await webSocketClient.receive());
}
// Close the connection.
await webSocketClient.disconnect();

connected

Whether a connection is currently open.

Returns boolean true if the connection is open.

dataAvailable

The number of messages available to receive.

Returns number The number of queued messages that can be retrieved with #receive

connect

Sets up a WebSocket connection to specified url. Resolves when the connection is established. Can be called again to reconnect to any url.

Parameters

• url string
• protocols string

Returns Promise<void>

send

Send data through the websocket. Must be connected. See #connected.

Parameters

• data any

receive

Asynchronously receive data from the websocket. Resolves immediately if there is buffered, unreceived data. Otherwise, resolves with the next rececived message, or rejects if disconnected.

Returns Promise<any> A promise that resolves with the data received.

disconnect

Initiates the close handshake if there is an active connection. Returns a promise that will never reject. The promise resolves once the WebSocket connection is closed.

Parameters

• code number
• reason string

Returns Promise<CloseEvent?>