socket.io - npm Package Compare versions

Comparing version 1.4.4 to 1.4.5

History.md

 
+1.4.5 / 2016-01-26
+==================
+
+  * fix closing the underlying `http.Server`
+
 1.4.4 / 2016-01-10
@@ -49,2 +54,3 @@ ==================
   * support compression [nkzawa]
+  * changed type of `Client#sockets`, `Namespace#sockets` and `Socket#rooms` to maps (instead of arrays)
 
@@ -51,0 +57,0 @@ 1.3.7 / 2015-09-21

lib/client.js

@@ -19,3 +19,3 @@
  * @param {Server} server instance
- * @param {Socket} connection
+ * @param {Socket} conn
  * @api private
@@ -58,3 +58,3 @@ */
  *
- * @param {String} namespace name
+ * @param {String} name namespace
  * @api private
@@ -138,3 +138,3 @@ */
  * @param {Object} packet object
- * @param {Object} options
+ * @param {Object} opts
  * @api private
@@ -206,3 +206,3 @@ */
  *
- * @param {Objcet} error object
+ * @param {Object} err object
  * @api private
@@ -209,0 +209,0 @@ */

lib/index.js

@@ -8,3 +8,2 @@
 var read = require('fs').readFileSync;
-var parse = require('url').parse;
 var engine = require('engine.io');
@@ -34,4 +33,4 @@ var client = require('socket.io-client');
  *
- * @param {http.Server|Number|Object} http server, port or options
- * @param {Object} options
+ * @param {http.Server|Number|Object} srv http server, port or options
+ * @param {Object} opts
  * @api public
@@ -59,4 +58,4 @@ */
  *
- * @param {http.IncomingMessage} request
- * @param {Function} callback to be called with the result: `fn(err, success)`
+ * @param {http.IncomingMessage} req request
+ * @param {Function} fn callback to be called with the result: `fn(err, success)`
  */
@@ -93,3 +92,3 @@
  *
- * @param {Boolean} whether to serve client code
+ * @param {Boolean} v whether to serve client code
  * @return {Server|Boolean} self when setting or value when getting
@@ -147,3 +146,3 @@ * @api public
  *
- * @param {String} pathname
+ * @param {String} v pathname
  * @return {Server|String} self when setting or value when getting
@@ -162,3 +161,3 @@ * @api public
  *
- * @param {Adapter} pathname
+ * @param {Adapter} v pathname
  * @return {Server|Adapter} self when setting or value when getting
@@ -182,3 +181,3 @@ * @api public
  *
- * @param {String} origins
+ * @param {String} v origins
  * @return {Server|Adapter} self when setting or value when getting
@@ -253,3 +252,3 @@ * @api public
  *
- * @param {Function|http.Server} http server
+ * @param {Function|http.Server} srv http server
  * @api private
@@ -304,3 +303,3 @@ */
  *
- * @param {engine.Server} engine.io (or compatible) server
+ * @param {engine.Server} engine engine.io (or compatible) server
  * @return {Server} self
@@ -319,3 +318,3 @@ * @api public
  *
- * @param {engine.Socket} socket
+ * @param {engine.Socket} conn
  * @return {Server} self
@@ -335,4 +334,4 @@ * @api public
  *
- * @param {String} nsp name
- * @param {Function} optional, nsp `connection` ev handler
+ * @param {String} name nsp name
+ * @param {Function} fn optional, nsp `connection` ev handler
  * @api public
@@ -339,0 +338,0 @@ */

lib/namespace.js

@@ -107,3 +107,3 @@
  * @param {Socket} socket that will get added
- * @param {Function} last fn call in the middleware
+ * @param {Function} fn last fn call in the middleware
  * @api private
@@ -264,3 +264,3 @@ */
  *
- * @param {Boolean} if `true`, compresses the sending data
+ * @param {Boolean} compress if `true`, compresses the sending data
  * @return {Socket} self
@@ -267,0 +267,0 @@ * @api public

lib/socket.js

@@ -91,3 +91,3 @@
 /**
- * `request` engine.io shorcut.
+ * `request` engine.io shortcut.
  *
@@ -203,3 +203,3 @@ * @api public
  * @param {Object} packet object
- * @param {Object} options
+ * @param {Object} opts options
  * @api private
@@ -219,3 +219,3 @@ */
  * @param {String} room
- * @param {Function} optional, callback
+ * @param {Function} fn optional, callback
  * @return {Socket} self
@@ -245,3 +245,3 @@ * @api private
  * @param {String} room
- * @param {Function} optional, callback
+ * @param {Function} fn optional, callback
  * @return {Socket} self
@@ -345,3 +345,3 @@ * @api private
  *
- * @param {Number} packet id
+ * @param {Number} id packet id
  * @api private
@@ -417,3 +417,3 @@ */
  * @param {String} reason
- * @param {Error} optional error object
+ * @throw {Error} optional error object
  * @api private
@@ -437,3 +437,3 @@ */
  *
- * @param {Object} error object
+ * @param {Object} err error object
  * @api private
@@ -449,3 +449,3 @@ */
  *
- * @param {Boolean} if `true`, closes the underlying connection
+ * @param {Boolean} close if `true`, closes the underlying connection
  * @return {Socket} self
@@ -469,3 +469,3 @@ * @api public
  *
- * @param {Boolean} if `true`, compresses the sending data
+ * @param {Boolean} compress if `true`, compresses the sending data
  * @return {Socket} self
@@ -472,0 +472,0 @@ * @api public

package.json

 {
   "name": "socket.io",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "node.js realtime framework server",
@@ -24,5 +24,5 @@ "keywords": [
   "dependencies": {
-    "engine.io": "1.6.7",
+    "engine.io": "1.6.8",
     "socket.io-parser": "2.2.6",
-    "socket.io-client": "1.4.4",
+    "socket.io-client": "1.4.5",
     "socket.io-adapter": "0.4.0",
@@ -34,7 +34,7 @@ "has-binary": "0.1.7",
     "expect.js": "0.3.1",
-    "istanbul": "0.2.3",
+    "istanbul": "0.4.1",
     "mocha": "2.3.4",
-    "superagent": "0.17.0",
-    "supertest": "0.8.2",
-    "zuul-ngrok": "3.1.0"
+    "superagent": "1.6.1",
+    "supertest": "1.1.0",
+    "zuul-ngrok": "3.2.0"
   },
@@ -41,0 +41,0 @@ "contributors": [

Readme.md

@@ -5,2 +5,4 @@
 [![Build Status](https://secure.travis-ci.org/socketio/socket.io.svg)](https://travis-ci.org/socketio/socket.io)
+[![Dependency Status](https://david-dm.org/socketio/socket.io.svg)](https://david-dm.org/socketio/socket.io)
+[![devDependency Status](https://david-dm.org/socketio/socket.io/dev-status.svg)](https://david-dm.org/socketio/socket.io#info=devDependencies)
 ![NPM version](https://badge.fury.io/js/socket.io.svg)
@@ -303,5 +305,6 @@ ![Downloads](https://img.shields.io/npm/dm/socket.io.svg?style=flat)
 
-### Socket#rooms:Array
+### Socket#rooms:Object
 
-  A list of strings identifying the rooms this socket is in.
+  A hash of strings identifying the rooms this socket is in, indexed by
+  room name.
 
@@ -308,0 +311,0 @@ ### Socket#client:Client

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

60886

increased by0.83%

Number of lines in readme file

428

increased by0.71%

Worsened metrics

Lines of code

1167

decreased by-0.09%

Dependency changes

• + Addedengine.io@1.6.8(transitive)

• + Addedengine.io-client@1.6.8(transitive)

• + Addedsocket.io-client@1.4.5(transitive)

• + Addedto-array@0.1.4(transitive)

• - Removedengine.io@1.6.7(transitive)

• - Removedengine.io-client@1.6.7(transitive)

• - Removedsocket.io-client@1.4.4(transitive)

• - Removedsocket.io-parser@2.2.5(transitive)

• - Removedto-array@0.1.3(transitive)

• Updatedengine.io@1.6.8

• Updatedsocket.io-client@1.4.5