Question 1

How to enable WebSocket compression in ws?

Accepted Answer

Use the perMessageDeflate option when creating a WebSocketServer or client, configuring zlibDeflateOptions and zlibInflateOptions for tuning. However, be cautious of performance overhead and memory issues in high-concurrency scenarios, as noted in the README.

Question 2

What does bufferutil do for ws performance?

Accepted Answer

Bufferutil is an optional binary addon that improves the performance of masking and unmasking WebSocket frames. Installing it can speed up data operations, but it requires a C++ compiler or prebuilt binaries, and you can disable it via the WS_NO_BUFFER_UTIL environment variable.

Question 3

How to detect and close broken WebSocket connections with ws?

Accepted Answer

Implement a heartbeat mechanism using ping and pong messages, as shown in the FAQ section. Set intervals to send pings and check for responses, terminating connections that don't respond within a timeout to handle network interruptions gracefully.

Question 4

How to use ws with Express.js for real-time features?

Accepted Answer

Attach a WebSocketServer to your Express HTTP server using the noServer option and handle upgrade requests in the server.on('upgrade') event. This allows sharing the same port for HTTP and WebSocket traffic, similar to the external server example in the README.

Question 5

ws vs Socket.IO: which is better for my project?

Accepted Answer

ws is a raw WebSocket implementation focused on performance and spec compliance, ideal for low-level control. Socket.IO offers higher-level features like rooms, automatic reconnection, and fallbacks, but with more overhead. Choose ws if you need speed and minimalism; Socket.IO for ease and robustness in unreliable networks.

Question 6

Does ws support secure WebSocket connections (WSS)?

Accepted Answer

Yes, ws supports WSS by integrating with Node.js HTTPS servers. Create an HTTPS server with SSL certificates and attach the WebSocketServer to it, as demonstrated in the external HTTP/S server example, ensuring encrypted real-time communication.

Question 7

How to broadcast messages to all connected clients in ws?

Accepted Answer

Iterate over the clients set in the WebSocketServer using wss.clients.forEach() and send messages to each open connection. The README provides examples for broadcasting to all clients or excluding the sender, requiring manual implementation for such common patterns.

ws

What is ws?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions