ws: a Node.js WebSocket library

Table of Contents

Protocol support

Installing

Opt-in for performance

Legacy opt-in for performance

API docs

WebSocket compression

Usage examples

Sending and receiving text data

Sending binary data

Simple server

External HTTP/S server

Multiple servers sharing a single HTTP/S server

Client authentication

Server broadcast

Round-trip time

Use the Node.js streams API

Other examples

FAQ

How to get the IP address of the client?

How to detect and close broken connections?

How to connect via a proxy?

Changelog

License