controller and vsorc data viewers done

[VSoRC/.git] / node_modules / express-ws / README.md

diff --git a/node_modules/express-ws/README.md b/node_modules/express-ws/README.md
new file mode 100644 (file)
index 0000000..9ade18a
--- /dev/null
+++ b/node_modules/express-ws/README.md
@@ -0,0 +1,111 @@
+# express-ws [![Dependency Status](https://snyk.io/test/github/henningm/express-ws/badge.svg)](https://snyk.io/test/github/henningm/express-ws)
+
+[WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API) endpoints for [Express](http://expressjs.com/) applications. Lets you define WebSocket endpoints like any other type of route, and applies regular Express middleware. The WebSocket support is implemented with the help of the [ws](https://github.com/websockets/ws) library.
+
+## Installation
+
+`npm install --save express-ws`
+
+## Usage
+
+__Full documentation can be found in the API section below. This section only shows a brief example.__
+
+Add this line to your Express application:
+
+```javascript
+var expressWs = require('express-ws')(app);
+```
+
+__Important: Make sure to set up the `express-ws` module like above *before* loading or defining your routers!__ Otherwise, `express-ws` won't get a chance to set up support for Express routers, and you might run into an error along the lines of `router.ws is not a function`.
+
+After setting up `express-ws`, you will be able to add WebSocket routes (almost) the same way you add other routes. The following snippet sets up a simple echo server at `/echo`.  The `ws` parameter is an instance of the WebSocket class described [here](https://github.com/websockets/ws/blob/master/doc/ws.md#class-websocket).
+
+```javascript
+app.ws('/echo', function(ws, req) {
+  ws.on('message', function(msg) {
+    ws.send(msg);
+  });
+});
+```
+
+It works with routers, too, this time at `/ws-stuff/echo`:
+
+```javascript
+var router = express.Router();
+
+router.ws('/echo', function(ws, req) {
+  ws.on('message', function(msg) {
+    ws.send(msg);
+  });
+});
+
+app.use("/ws-stuff", router);
+```
+
+## Full example
+
+```javascript
+var express = require('express');
+var app = express();
+var expressWs = require('express-ws')(app);
+
+app.use(function (req, res, next) {
+  console.log('middleware');
+  req.testing = 'testing';
+  return next();
+});
+
+app.get('/', function(req, res, next){
+  console.log('get route', req.testing);
+  res.end();
+});
+
+app.ws('/', function(ws, req) {
+  ws.on('message', function(msg) {
+    console.log(msg);
+  });
+  console.log('socket', req.testing);
+});
+
+app.listen(3000);
+```
+
+## API
+
+### expressWs(app, *server*, *options*)
+
+Sets up `express-ws` on the specified `app`. This will modify the global Router prototype for Express as well - see the `leaveRouterUntouched` option for more information on disabling this.
+
+* __app__: The Express application to set up `express-ws` on.
+* __server__: *Optional.* When using a custom `http.Server`, you should pass it in here, so that `express-ws` can use it to set up the WebSocket upgrade handlers. If you don't specify a `server`, you will only be able to use it with the server that is created automatically when you call `app.listen`.
+* __options__: *Optional.* An object containing further options.
+  * __leaveRouterUntouched:__ Set this to `true` to keep `express-ws` from modifying the Router prototype. You will have to manually `applyTo` every Router that you wish to make `.ws` available on, when this is enabled.
+  * __wsOptions:__ Options object passed to WebSocketServer constructor. Necessary for any ws specific features.
+
+This function will return a new `express-ws` API object, which will be referred to as `wsInstance` in the rest of the documentation.
+
+### wsInstance.app
+
+This property contains the `app` that `express-ws` was set up on.
+
+### wsInstance.getWss()
+
+Returns the underlying WebSocket server/handler. You can use `wsInstance.getWss().clients` to obtain a list of all the connected WebSocket clients for this server.
+
+Note that this list will include *all* clients, not just those for a specific route - this means that it's often *not* a good idea to use this for broadcasts, for example.
+
+### wsInstance.applyTo(router)
+
+Sets up `express-ws` on the given `router` (or other Router-like object). You will only need this in two scenarios:
+
+1. You have enabled `options.leaveRouterUntouched`, or
+2. You are using a custom router that is not based on the express.Router prototype.
+
+In most cases, you won't need this at all.
+
+## Development
+
+This module is written in ES6, and uses Babel for compilation. What this means in practice:
+
+* The source code lives in the `src/` directory.
+* After changing this code, make sure to run `npm run build` to compile it.