deps, readme, remove API docs

Author: 75lb

README.md

@@ -4,7 +4,6 @@
 [![Coverage Status](https://coveralls.io/repos/github/lwsjs/local-web-server/badge.svg?branch=master)](https://coveralls.io/github/lwsjs/local-web-server?branch=master)
 [![Dependency Status](https://badgen.net/david/dep/lwsjs/local-web-server)](https://david-dm.org/lwsjs/local-web-server)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
-[![Join the chat at https://gitter.im/lwsjs/local-web-server](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lwsjs/local-web-server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 **Requires node v8 or above. Upgraders, please read the [release notes](https://github.com/lwsjs/local-web-server/releases)**.
 
@@ -87,68 +86,6 @@ $ ws --http2
 Serving at https://mbp.local:8000, https://127.0.0.1:8000, https://192.168.0.100:8000
 ```
 
-### Mock responses
-
-Imagine the network is down or you're working offline, proxied requests to `https://internal-service.local/api/users/1` would fail. In this case, Mock Responses can fill the gap. Mocks are defined in a module which can be reused between projects.
-
-Trivial example - respond to a request for `/rivers` with some JSON. Save the following Javascript in a file named `example-mocks.js`.
-
-```js
-module.exports = MockBase => class MockRivers extends MockBase {
-  mocks () {
-    return {
-      route: '/rivers',
-      responses: [
-        {
-          response: {
-            type: 'json',
-            body: [
-              { name: 'Volga', drainsInto: 'Caspian Sea' },
-              { name: 'Danube', drainsInto: 'Black Sea' },
-              { name: 'Ural', drainsInto: 'Caspian Sea' },
-              { name: 'Dnieper', drainsInto: 'Black Sea' }
-            ]
-          }
-        }
-      ]
-    }
-  }
-}
-```
-
-Launch `ws` passing in your mocks module.
-
-```sh
-$ ws --mocks example-mocks.js
-Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000
-```
-
-GET your rivers.
-
-```sh
-$ curl http://127.0.0.1:8000/rivers
-[
-  {
-    "name": "Volga",
-    "drainsInto": "Caspian Sea"
-  },
-  {
-    "name": "Danube",
-    "drainsInto": "Black Sea"
-  },
-  {
-    "name": "Ural",
-    "drainsInto": "Caspian Sea"
-  },
-  {
-    "name": "Dnieper",
-    "drainsInto": "Black Sea"
-  }
-]
-```
-
-See [the tutorials](https://github.com/lwsjs/local-web-server/wiki#tutorials) for more information and examples about mock responses.
-
 ## Further Documentation
 
 [See the wiki for plenty more documentation and tutorials](https://github.com/lwsjs/local-web-server/wiki).

doc/api.md

@@ -23,25 +23,6 @@ const Lws = require('lws')
   * @alias module:local-web-server
   */
 class LocalWebServer extends Lws {
-  /**
-   * Returns a listening HTTP/HTTPS server.
-   * @param [options] {object} - Server options
-   * @param [options.port] {number} - Port
-   * @param [options.hostname] {string} -The hostname (or IP address) to listen on. Defaults to 0.0.0.0.
-   * @param [options.maxConnections] {number} - The maximum number of concurrent connections supported by the server.
-   * @param [options.keepAliveTimeout] {number} - The period (in milliseconds) of inactivity a connection will remain open before being destroyed. Set to `0` to keep connections open indefinitely.
-   * @param [options.configFile] {string} - Config file path, defaults to 'lws.config.js'.
-   * @param [options.https] {boolean} - Enable HTTPS using a built-in key and cert registered to the domain 127.0.0.1.
-   * @param [options.key] {string} - SSL key file path. Supply along with --cert to launch a https server.
-   * @param [options.cert] {string} - SSL cert file path. Supply along with --key to launch a https server.
-   * @param [options.pfx] {string} - Path to an PFX or PKCS12 encoded private key and certificate chain. An alternative to providing --key and --cert.
-   * @param [options.ciphers] {string} - Optional cipher suite specification, replacing the default.
-   * @param [options.secureProtocol] {string} - Optional SSL method to use, default is "SSLv23_method".
-   * @param [options.stack] {string[]|Middlewares[]} - Array of feature classes, or filenames of modules exporting a feature class.
-   * @param [options.moduleDir] {string[]} - One or more directories to search for modules.
-   * @returns {Server}
-   */
-
   getDefaultConfig () {
     return Object.assign(super.getDefaultConfig(), {
       moduleDir: [ __dirname, '.' ],
@@ -50,12 +31,4 @@ class LocalWebServer extends Lws {
   }
 }
 
-/**
- * Highly-verbose debug information event stream.
- *
- * @event module:local-web-server#verbose
- * @param key {string} - An identifying string, e.g. `server.socket.data`.
- * @param value {*} - The value, e.g. `{ socketId: 1, bytesRead: '3 Kb' }`.
- */
-
 module.exports = LocalWebServer

index.js

@@ -20,14 +20,17 @@
     "rest",
     "mock",
     "api",
-    "proxy"
+    "proxy",
+    "lws",
+    "backend",
+    "frontend",
+    "full-stack"
   ],
   "engines": {
     "node": ">=8"
   },
   "scripts": {
     "test": "test-runner test/*.js",
-    "docs": "jsdoc2md -p list index.js lib/*.js > doc/api.md; echo",
     "cover": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
   },
   "files": [
@@ -36,26 +39,26 @@
     "index.js"
   ],
   "dependencies": {
-    "lws": "2.0.0-8",
+    "lws": "2.0.0-9",
     "lws-basic-auth": "^1.0.2",
     "lws-blacklist": "^2.0.1",
     "lws-body-parser": "^1.0.1",
     "lws-compress": "^1.0.1",
     "lws-conditional-get": "^1.0.0",
     "lws-cors": "^2.0.0",
-    "lws-index": "^1.0.1",
+    "lws-index": "^1.0.2",
     "lws-json": "^1.0.0",
     "lws-log": "^1.0.0",
     "lws-mime": "^1.0.0",
     "lws-range": "^2.0.0",
-    "lws-request-monitor": "^1.0.1",
+    "lws-request-monitor": "^1.0.3",
     "lws-rewrite": "^2.0.0",
     "lws-spa": "^2.0.0",
     "lws-static": "^1.1.0",
     "node-version-matches": "^1.0.1"
   },
   "devDependencies": {
-    "coveralls": "^3.0.3",
+    "coveralls": "^3.0.4",
     "jsdoc-to-markdown": "^5.0.0",
     "node-fetch": "^2.6.0",
     "nyc": "^14.1.1",