websocket: document ws require

socketio · Jan 22, 2014 · 3841d7b · 3841d7b
1 parent 3655acd
commit 3841d7b
Showing 1 changed file with 8 additions and 1 deletion.
diff --git 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.
  */