websocket-stream
Advanced tools
Comparing version 1.0.0 to 1.0.1
@@ -28,2 +28,4 @@ var through = require('through2') | ||
} | ||
stream.socket = socket | ||
@@ -30,0 +32,0 @@ socket.addEventListener("close", onclose) |
{ | ||
"name": "websocket-stream", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "Use websockets with the node streams API. Works in browser and node", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -5,7 +5,7 @@ # websocket-stream | ||
Use HTML5 [websockets](https://developer.mozilla.org/en-US/docs/WebSockets) using the Node Streams API. Works in Node or in Browsers. | ||
Use HTML5 [websockets](https://developer.mozilla.org/en-US/docs/WebSockets) using the Node Streams API. | ||
### In the browser | ||
### Usage | ||
You can use [browserify](http://github.com/substack/node-browserify) to package this module for browser use. | ||
This module works in Node or in Browsers that support WebSockets. You can use [browserify](http://github.com/substack/node-browserify) to package this module for browser use. | ||
@@ -20,2 +20,4 @@ ```javascript | ||
The underlying `WebSocket` instance is available as `ws.socket`. | ||
### On the server | ||
@@ -35,16 +37,15 @@ | ||
## run the tests | ||
## Run the tests | ||
### server-side tests | ||
### Server-side tests | ||
``` | ||
npm test | ||
``` | ||
### client side tests | ||
### Client-side tests | ||
first start the echo server by running `node test-server.js` | ||
First start the echo server by running `node test-server.js` | ||
then run `npm start` and open `localhost:9966` in your browser and open the Dev Tools console to see test output | ||
Then run `npm start` and open `localhost:9966` in your browser and open the Dev Tools console to see test output. | ||
@@ -51,0 +52,0 @@ ## license |
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
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
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
8331
163
52
1