[apps/tidep0084.git] / prebuilt / iot-gateway / node_modules / aws-iot-device-sdk / node_modules / websocket-stream / readme.md
diff --git a/prebuilt/iot-gateway/node_modules/aws-iot-device-sdk/node_modules/websocket-stream/readme.md b/prebuilt/iot-gateway/node_modules/aws-iot-device-sdk/node_modules/websocket-stream/readme.md
+++ /dev/null
@@ -1,70 +0,0 @@
-# websocket-stream
-
-[](https://nodei.co/npm/websocket-stream/)
-
-Use HTML5 [websockets](https://developer.mozilla.org/en-US/docs/WebSockets) using the Node Streams API.
-
-### Usage
-
-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.
-
-```javascript
-var websocket = require('websocket-stream')
-var ws = websocket('ws://realtimecats.com')
-ws.pipe(somewhereAwesome)
-```
-
-In the example above `ws` is a duplex stream. That means you can pipe output to anything that accepts streams. You can also pipe data into streams (such as a webcam feed or audio data).
-
-The underlying `WebSocket` instance is available as `ws.socket`.
-
-#### Options
-
-The available options differs depending on if you use this module in the browser or with node.js. Options can be passed in as the third or second argument - `WebSocket(address, [protocols], [options])`
-
-##### `options.browserBufferSize`
-
-How much to allow the [socket.bufferedAmount](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#Attributes) to grow before starting to throttle writes. This option has no effect in node.js.
-
-Default: `1024 * 512` (512KiB)
-
-##### `options.browserBufferTimeout`
-
-How long to wait before checking if the socket buffer has drained sufficently for another write. This option has no effect in node.js.
-
-Default: `1000` (1 second)
-
-##### Other options
-
-When used in node.js see the [ws.WebSocket documentation](https://github.com/websockets/ws/blob/master/doc/ws.md#class-wswebsocket)
-
-### On the server
-
-Using the [`ws`](http://npmjs.org/ws) module you can make a websocket server and use this module to get websocket streams on the server:
-
-```javascript
-var websocket = require('websocket-stream')
-var wss = websocket.createServer({server: someHTTPServer}, handle)
-
-function handle(stream) {
- fs.createReadStream('bigdata.json').pipe(stream)
-}
-```
-
-## Run the tests
-
-### Server-side tests
-
-```
-npm test
-```
-
-### Client-side tests
-
-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.
-
-## license
-
-BSD LICENSE