websocket-stream - npm Package Compare versions

Comparing version 5.0.1 to 5.1.0

package.json

 {
   "name": "websocket-stream",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "license": "BSD-2-Clause",
@@ -26,7 +26,7 @@ "description": "Use websockets with the node streams API. Works in browser and node",
   "dependencies": {
-    "duplexify": "^3.2.0",
+    "duplexify": "^3.5.1",
     "inherits": "^2.0.1",
-    "readable-stream": "^2.2.0",
-    "safe-buffer": "^5.0.1",
-    "ws": "^3.0.0",
+    "readable-stream": "^2.3.3",
+    "safe-buffer": "^5.1.1",
+    "ws": "^3.2.0",
     "xtend": "^4.0.0"
@@ -36,5 +36,5 @@ },
     "beefy": "^2.1.1",
-    "browserify": "^14.0.0",
+    "browserify": "^14.5.0",
     "concat-stream": "^1.4.7",
-    "tape": "^4.6.0"
+    "tape": "^4.8.0"
   },
@@ -41,0 +41,0 @@ "optionalDependencies": {},

readme.md

@@ -13,4 +13,5 @@ # websocket-stream
 var websocket = require('websocket-stream')
-var ws = websocket('ws://realtimecats.com')
-ws.pipe(somewhereAwesome)
+var ws = websocket('ws://echo.websocket.org')
+process.stdin.pipe(ws)
+ws.pipe(process.stdout)
 ```
@@ -105,2 +106,29 @@
 
+You can even use it on express.js with the [express-ws](https://www.npmjs.com/package/express-ws) library:
+
+```js
+const express = require('express');
+const expressWebSocket = require('express-ws');
+const websocketStream = require('websocket-stream/stream');
+const app = express();
+
+// extend express app with app.ws()
+expressWebSocket(app, null, {
+    // ws options here
+    perMessageDeflate: false,
+});
+ 
+app.ws('/bigdata.json', function(ws, req) {
+  // convert ws instance to stream
+  const stream = websocketStream(ws, {
+    // websocket-stream options here
+    binary: true,
+  });
+
+  fs.createReadStream('bigdata.json').pipe(stream);
+});
+ 
+app.listen(3000);
+```
+
 ## Run the tests
@@ -107,0 +135,0 @@

stream.js

@@ -15,14 +15,10 @@ 'use strict'
 
-  proxy._destroyed = false
   proxy._write = socketWrite
   proxy._flush = socketEnd
 
-  proxy.destroy = function(err) {
-    if (this._destroyed) return
-      this._destroyed = true
-
+  proxy._destroy = function(err, cb) {
     var self = this
+    this.push(null)
     process.nextTick(function() {
-      if (err)
-        self.emit('error', err)
+      cb(err);
       self.emit('close')
@@ -159,3 +155,3 @@ })
     var data = event.data
-    if (data instanceof ArrayBuffer) data = Buffer.from(new Uint8Array(data))
+    if (data instanceof ArrayBuffer) data = Buffer.from(data)
     else data = Buffer.from(data, 'utf8')
@@ -162,0 +158,0 @@ proxy.push(data)

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

22716

increased by2.46%

Number of lines in readme file

149

increased by23.14%

Worsened metrics

Number of package files

12

decreased by-7.69%

Lines of code

559

decreased by-0.53%

Dependency changes

• Updatedduplexify@^3.5.1

• Updatedreadable-stream@^2.3.3

• Updatedsafe-buffer@^5.1.1

• Updatedws@^3.2.0