http-proxy-middleware 0.17.0 → 0.17.3

package/recipes/proxy-events.md

@@ -1,74 +0,0 @@
-# Proxy Events
-
-Subscribe to [`http-proxy`](https://github.com/nodejitsu/node-http-proxy) [![GitHub stars](https://img.shields.io/github/stars/nodejitsu/node-http-proxy.svg?style=social&label=Star)](https://github.com/nodejitsu/node-http-proxy) events: `error`, `proxyReq`, `proxyReqWs`, `proxyRes`, `open`, `close`.
-
-## onError
-
-Subscribe to http-proxy's [error event](https://www.npmjs.com/package/http-proxy#listening-for-proxy-events).
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var onError = function (err, req, res) {
-    console.log('Something went wrong.');
-    console.log('And we are reporting a custom error message.');
-};
-
-var options = {target:'http://localhost:3000', onError: onError};
-
-var apiProxy = proxy('/api', options);
-```
-
-## onProxyReq
-
-Subscribe to http-proxy's [proxyReq event](https://www.npmjs.com/package/http-proxy#listening-for-proxy-events).
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var onProxyReq = function (proxyReq, req, res) {
-    // add new header to request
-    proxyReq.setHeader('x-added', 'foobar');
-};
-
-var options = {target:'http://localhost:3000', onProxyReq: onProxyReq};
-
-var apiProxy = proxy('/api', options);
-```
-
-## onProxyReqWs
-
-Subscribe to http-proxy's [proxyReqWs event](https://www.npmjs.com/package/http-proxy#listening-for-proxy-events).
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var onProxyReqWs = function (proxyReq, req, socket, options, head) {
-    // add custom header
-    proxyReq.setHeader('X-Special-Proxy-Header', 'foobar');
-};
-
-var options = {target:'http://localhost:3000', onProxyReq: onProxyReqWs};
-
-var apiProxy = proxy('/api', options);
-```
-
-## onProxyRes
-
-Subscribe to http-proxy's [proxyRes event](https://www.npmjs.com/package/http-proxy#listening-for-proxy-events).
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var onProxyRes = function (proxyRes, req, res) {
-    // add new header to response
-    proxyRes.headers['x-added'] = 'foobar';
-
-    // remove header from response
-    delete proxyRes.headers['x-removed'];
-};
-
-var options = {target:'http://localhost:3000', onProxyRes: onProxyRes};
-
-var apiProxy = proxy('/api', options);
-```

package/recipes/router.md

@@ -1,83 +0,0 @@
-# router
-
-Allows you to route to a different `target` by using a table of a custom function.
-
-<!-- MarkdownTOC autolink=true bracket=round -->
-
-- [Custom router function](#custom-router-function)
-- [Proxy Table](#proxy-table)
-
-<!-- /MarkdownTOC -->
-
-
-## Custom router function
-
-Write your own router to dynamically route to a different `target`.
-The `req` object is provided to retrieve contextual data.
-
-```javascript
-var express = require('express');
-var proxy = require("http-proxy-middleware");
-
-var customRouter = function(req) {
-    return 'http://www.example.org'    // protocol + host
-};
-
-var options = {
-    target: 'http://localhost:8000',
-    router: customRouter
-};
-
-var myProxy = proxy(options);
-
-var app = express();
-app.use(myProxy);                      // add the proxy to express
-
-app.listen(3000);
-```
-
-
-## Proxy Table
-
-Use a Proxy Table to proxy requests to a different `target` based on:
-* Host [HTTP header](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields).
-* Request path
-* Host HTTP header + path
-
-```javascript
-var express = require('express');
-var proxy = require("http-proxy-middleware");
-
-var proxyTable = {
-    "integration.localhost:3000" : "http://localhost:8001",    // host only
-    "staging.localhost:3000"     : "http://localhost:8002",    // host only
-    "localhost:3000/api"         : "http://localhost:8003",    // host + path
-    "/rest"                      : "http://localhost:8004"     // path only
-};
-
-var options = {
-    target: 'http://localhost:8000',
-    router: proxyTable
-};
-
-var myProxy = proxy(options);
-
-var app = express();
-app.use(myProxy);                      // add the proxy to express
-
-app.listen(3000);
-```
-
-### Example
-
-In the example above; all requests will be proxied to `http://localhost:8000`.
-
-When request's `Host HTTP header` and/or `path` match a configuration in the proxyTable, they will be send to matching target.
-
-```
-http://localhost:3000/lorum/ipsum             -> http://localhost:8000/lorum/ipsum
-http://integration.localhost:3000/lorum/ipsum -> http://localhost:8001/lorum/ipsum
-http://staging.localhost:3000/rest/foo/bar    -> http://localhost:8002/rest/foo/bar
-http://localhost:3000/api/houses/123          -> http://localhost:8003/api/houses/123
-http://localhost:3000/rest/books/123          -> http://localhost:8004/rest/books/123
-```

package/recipes/servers.md

@@ -1,252 +0,0 @@
-# Servers
-
-Overview of `http-proxy-middleware` implementation in different servers.
-
-Missing a server? Feel free to extend this list of examples.
-
-<!-- MarkdownTOC autolink=true bracket=round -->
-
-- [Browser-Sync](#browser-sync)
-- [Express](#express)
-- [Connect](#connect)
-- [lite-server](#lite-server)
-- [grunt-contrib-connect](#grunt-contrib-connect)
-- [grunt-browser-sync](#grunt-browser-sync)
-- [gulp-connect](#gulp-connect)
-- [gulp-webserver](#gulp-webserver)
-
-<!-- /MarkdownTOC -->
-
-## Browser-Sync 
-
-https://github.com/BrowserSync/browser-sync
-[![GitHub stars](https://img.shields.io/github/stars/BrowserSync/browser-sync.svg?style=social&label=Star)](https://github.com/BrowserSync/browser-sync)
-
-```javascript
-var browserSync = require('browser-sync').create();
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-browserSync.init({
-    server: {
-        baseDir: './',
-        port: 3000,
-        middleware: [apiProxy],
-    },
-    startPath: '/api'
-});
-
-```
-
-## Express
-
-https://github.com/expressjs/express
-[![GitHub stars](https://img.shields.io/github/stars/expressjs/express.svg?style=social&label=Star)](https://github.com/expressjs/express)
-
-```javascript
-var express = require('express');
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-var app = express();
-
-app.use(apiProxy);
-app.listen(3000);
-```
-
-## Connect
-
-https://github.com/senchalabs/connect
-[![GitHub stars](https://img.shields.io/github/stars/senchalabs/connect.svg?style=social&label=Star)](https://github.com/senchalabs/connect)
-
-```javascript
-var http = require('http');
-var connect = require('connect');
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-var app = connect();
-app.use(apiProxy);
-
-http.createServer(app).listen(3000);
-```
-
-## lite-server
-
-https://github.com/johnpapa/lite-server
-[![GitHub stars](https://img.shields.io/github/stars/johnpapa/lite-server.svg?style=social&label=Star)](https://github.com/johnpapa/lite-server) ([example source](https://github.com/johnpapa/lite-server/issues/61#issuecomment-205997607))
-
-File: `bs-config.js`
-
-```javascript
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-module.exports = {
-    server: {
-        middleware: {
-            1: apiProxy
-        }
-    }
-};
-```
-
-## grunt-contrib-connect
-
-https://github.com/gruntjs/grunt-contrib-connect
-[![GitHub stars](https://img.shields.io/github/stars/gruntjs/grunt-contrib-connect.svg?style=social&label=Star)](https://github.com/gruntjs/grunt-contrib-connect)
-
-As an `Array`:
-```javascript
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-grunt.initConfig({
-    connect: {
-        server: {
-            options: {
-                middleware: [apiProxy],
-            },
-        },
-    },
-});
-```
-
-As a `function`:
-```javascript
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-grunt.initConfig({
-  connect: {
-    server: {
-      options: {
-        middleware: function(connect, options, middlewares) {
-          // inject a custom middleware into the array of default middlewares
-          middlewares.unshift(apiProxy);
-
-          return middlewares;
-        },
-      },
-    },
-  },
-});
-```
-
-
-## grunt-browser-sync
-
-https://github.com/BrowserSync/grunt-browser-sync
-[![GitHub stars](https://img.shields.io/github/stars/BrowserSync/grunt-browser-sync.svg?style=social&label=Star)](https://github.com/BrowserSync/grunt-browser-sync)
-
-
-```javascript
-var proxy = require('http-proxy-middleware');
-
-var apiProxy = proxy('/api', {
-    target: 'http://www.example.org',
-    changeOrigin: true   // for vhosted sites
-});
-
-grunt.initConfig({
-
-    // BrowserSync Task
-    browserSync: {
-        default_options: {
-            options: {
-                files: [
-                    "css/*.css",
-                    "*.html"
-                ],
-                port: 9000,
-                server: {
-                    baseDir: ['app'],
-                    middleware: apiProxy
-                }
-            }
-        }
-    }
-
-});
-```
-
-## gulp-connect
-
-https://github.com/avevlad/gulp-connect
-[![GitHub stars](https://img.shields.io/github/stars/avevlad/gulp-connect.svg?style=social&label=Star)](https://github.com/avevlad/gulp-connect)
-
-```javascript
-var gulp = require('gulp');
-var connect = require('gulp-connect');
-var proxy = require('http-proxy-middleware');
-
-gulp.task('connect', function() {
-    connect.server({
-        root: ['./app'],
-        middleware: function(connect, opt) {
-
-            var apiProxy = proxy('/api', {
-                target: 'http://www.example.org',
-                changeOrigin: true   // for vhosted sites
-            });
-
-            return [apiProxy];
-        }
-
-    });
-});
-
-gulp.task('default', ['connect']);
-```
-
-## gulp-webserver
-
-https://github.com/schickling/gulp-webserver
-[![GitHub stars](https://img.shields.io/github/stars/schickling/gulp-webserver.svg?style=social&label=Star)](https://github.com/schickling/gulp-webserver)
-
-```javascript
-var gulp = require('gulp');
-var webserver = require('gulp-webserver');
-var proxy = require('http-proxy-middleware');
-
-gulp.task('webserver', function() {
-    var apiProxy = proxy('/api', {
-        target: 'http://www.example.org',
-        changeOrigin: true   // for vhosted sites
-    });
-
-    gulp.src('app')
-        .pipe(webserver({
-            livereload: true,
-            directoryListing: true,
-            open: true,
-            middleware: [apiProxy]
-        }));
-});
-
-gulp.task('default', ['webserver']);
-```

package/recipes/shorthand.md

@@ -1,63 +0,0 @@
-# Shorthand
-
-This example will create a proxy middleware using the shorthand notation.
-
-The http-proxy-middleware `context` and `config.target` will be set automatically.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var apiProxy = proxy('http://localhost:3000/api');
-
-// equivalent:
-// var apiProxy = proxy('/api', {target:'http://localhost:3000'});
-```
-
-## Shorthand - Wildcard context
-
-This example will create a proxy middleware with shorthand wildcard context.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var apiProxy = proxy('http://localhost:3000/api/books/*/**.json');
-// equals:
-// var apiProxy = proxy('/api/books/*/**.json', {target:'http://localhost:3000'});
-```
-
-
-## Shorthand with additional configuration
-
-This example will create a proxy middleware with shorthand and additional configuration.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var apiProxy = proxy('http://localhost:3000/api', {changeOrigin: true});
-// equals:
-// var apiProxy = proxy('/api', {target:'http://localhost:3000', {changeOrigin:true}});
-```
-
-## Shorthand - WebSocket
-
-This example will create a proxy middleware with shorthand and additional configuration for WebSocket support.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var apiProxy = proxy('http://localhost:3000/api', {ws: true});
-// equals:
-// var apiProxy = proxy('/api', {target:'http://localhost:3000', ws: true});
-```
-
-## Shorthand - WebSocket only
-
-This example will create a proxy middleware with websocket shorthand only configuration.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var apiProxy = proxy('ws://localhost:3000/api');
-// equals:
-// var apiProxy = proxy('/api', {target:'ws://localhost:3000', ws: true});
-```

package/recipes/virtual-hosts.md

@@ -1,18 +0,0 @@
-# Name-based Virtual Hosts
-
-This example will create a basic proxy middleware for [virtual hosted sites](https://en.wikipedia.org/wiki/Virtual_hosting#Name-based).
-
-When `changeOrigin` is set to `true`; Host [HTTP header](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields) will be set to match target's host.
-
-The `changeOrigin` option is provided by [http-proxy](https://github.com/nodejitsu/node-http-proxy).
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var options = {
-    target: 'http://localhost:3000',
-    changeOrigin:true
-};
-
-var apiProxy = proxy('/api', options);
-```

package/recipes/websocket.md

@@ -1,41 +0,0 @@
-# WebSocket
-
-This example will create a proxy middleware with websocket support.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var socketProxy = proxy('/socket', {target: 'http://localhost:3000', ws: true});
-```
-
-## WebSocket - Path Rewrite
-
-This example will create a proxy middleware with websocket support and pathRewrite.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var options = {
-        target: 'http://localhost:3000',
-        ws: true,
-        pathRewrite: {
-            '^/socket' : ''
-        }
-    };
-
-var socketProxy = proxy('/socket', options);
-```
-
-## WebSocket - Server update subscription
-
-This example will create a proxy middleware with websocket support.
-
-Subscribe to server's upgrade event.
-
-```javascript
-var proxy = require("http-proxy-middleware");
-
-var socketProxy = proxy('/socket', {target: 'http://localhost:3000', ws: true});
-
-server.on('upgrade', proxy.upgrade);    // <-- subscribe to http 'upgrade'
-```

package/test/e2e/_utils.js

@@ -1,21 +0,0 @@
-var express = require('express');
-var proxyMiddleware = require('../../index');
-
-module.exports = {
-    createServer: createServer,
-    proxyMiddleware: proxyMiddleware
-};
-
-function createServer(portNumber, middleware, path) {
-    var app = express();
-
-    if (middleware, path) {
-        app.use(path, middleware);
-    } else if (middleware) {
-        app.use(middleware);
-    }
-
-    var server = app.listen(portNumber);
-
-    return server;
-}