From 3841d7b8463cc416d733a22a42f7d0d89717ba7d Mon Sep 17 00:00:00 2001 From: Guillermo Rauch Date: Wed, 22 Jan 2014 15:29:07 -0800 Subject: [PATCH] websocket: document `ws` require --- lib/transports/websocket.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/transports/websocket.js b/lib/transports/websocket.js index 324d55f91..a5f0102c5 100644 --- a/lib/transports/websocket.js +++ b/lib/transports/websocket.js @@ -3,11 +3,18 @@ */ var Transport = require('../transport'); -var WebSocket = require('ws'); var parser = require('engine.io-parser'); var util = require('../util'); var debug = require('debug')('engine.io-client:websocket'); +/** + * `ws` exposes a WebSocket-compatible interface in + * Node, or the `WebSocket` or `MozWebSocket` globals + * in the browser. + */ + +var WebSocket = require('ws'); + /** * Module exports. */