engine.io
Advanced tools
engine.io - npm Package Compare versions
Comparing version 3.2.0 to 3.2.1
@@ -505,3 +505,3 @@ | ||
| if (socket.writable) { | ||
| var message = Server.errorMessages.hasOwnProperty(code) ? Server.errorMessages[code] : (code || ''); | ||
| var message = Server.errorMessages.hasOwnProperty(code) ? Server.errorMessages[code] : String(code || ''); | ||
| var length = Buffer.byteLength(message); | ||
@@ -508,0 +508,0 @@ socket.write( |
| { | ||
| "name": "engine.io", | ||
| "version": "3.2.0", | ||
| "version": "3.2.1", | ||
| "description": "The realtime engine behind Socket.IO. Provides the foundation of a bidirectional connection between client and server", | ||
@@ -38,3 +38,3 @@ "main": "lib/engine.io", | ||
| "babel-preset-es2015": "^6.24.0", | ||
| "engine.io-client": "3.2.0", | ||
| "engine.io-client": "3.2.1", | ||
| "eslint": "^4.5.0", | ||
@@ -41,0 +41,0 @@ "eslint-config-standard": "^10.2.1", |
@@ -132,17 +132,23 @@ | ||
| The following are identical ways to instantiate a server and then attach it. | ||
| ```js | ||
| var httpServer; // previously created with `http.createServer();` from node.js api. | ||
| // create a server first, and then attach | ||
| var eioServer = require('engine.io').Server(); | ||
| eioServer.attach(httpServer); | ||
| ```js | ||
| var httpServer; // previously created with `http.createServer();` from node.js api. | ||
| // or call the module as a function to get `Server` | ||
| var eioServer = require('engine.io')(); | ||
| eioServer.attach(httpServer); | ||
| // create a server first, and then attach | ||
| var eioServer = require('engine.io').Server(); | ||
| eioServer.attach(httpServer); | ||
| // immediately attach | ||
| var eioServer = require('engine.io')(httpServer); | ||
| ``` | ||
| // or call the module as a function to get `Server` | ||
| var eioServer = require('engine.io')(); | ||
| eioServer.attach(httpServer); | ||
| // immediately attach | ||
| var eioServer = require('engine.io')(httpServer); | ||
| // with custom options | ||
| var eioServer = require('engine.io')(httpServer, { | ||
| maxHttpBufferSize: 1e3 | ||
| }); | ||
| ``` | ||
| - `listen` | ||
@@ -159,2 +165,13 @@ - Creates an `http.Server` which listens on the given port and attaches WS | ||
| - **Returns** `Server` | ||
| ```js | ||
| var engine = require('engine.io'); | ||
| var server = engine.listen(3000, { | ||
| pingTimeout: 2000, | ||
| pingInterval: 10000 | ||
| }); | ||
| server.on('connection', /* ... */); | ||
| ``` | ||
| - `attach` | ||
@@ -171,4 +188,12 @@ - Captures `upgrade` requests for a `http.Server`. In other words, makes | ||
| <hr><br> | ||
| ```js | ||
| var engine = require('engine.io'); | ||
| var httpServer = require('http').createServer().listen(3000); | ||
| var server = engine.attach(httpServer, { | ||
| wsEngine: 'uws' // requires having uws as dependency | ||
| }); | ||
| server.on('connection', /* ... */); | ||
| ``` | ||
| #### Server | ||
@@ -175,0 +200,0 @@ |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by0.71%
69129
- Number of lines in readme file
- increased by4.63%
565