archive-gh-me/node-http-proxy
1
0
Fork 0
mirror of https://github.com/http-party/node-http-proxy.git synced 2025-12-08 20:59:18 +00:00
Code Issues Projects Releases Wiki Activity

[api] export the httpProxy.Server as the main export but preserve the createServer factory

Browse Source
This commit is contained in:
Jarrett Cruger 2013-12-27 19:01:28 -05:00
parent e5991519db
commit 182c76cd23
1 changed files with 21 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
lib/http-proxy.js
View File

@ -1,8 +1,14 @@
var http = require('http'),
https = require('https'),
url = require('url'),
httpProxy = require('./http-proxy/'),
proxy = exports;
httpProxy = require('./http-proxy/');
/**
* Export the "Server" so we can have an intuitive api for just creating
* a proxy
*
*/
module.exports = httpProxy.Server;
/**
* Creates the proxy server.
@ -19,23 +25,23 @@ var http = require('http'),
* @api public
*/
proxy.createProxyServer = proxy.createServer = function createProxyServer(options) {
module.exports.createProxyServer = module.exports.createServer = function createProxyServer(options) {
/*
* `options` is needed and it must have the following layout:
*
* {
* target : <url string to be parsed with the url module>
* forward: <url string to be parsed with the url module>
* agent : <object to be passed to http(s).request>
* ssl : <object to be passed to https.createServer()>
*
* {
* target : <url string to be parsed with the url module>
* forward: <url string to be parsed with the url module>
* agent : <object to be passed to http(s).request>
* ssl : <object to be passed to https.createServer()>
* ws : <true/false, if you want to proxy websockets>
* xfwd : <true/false, adds x-forward headers>
* xfwd : <true/false, adds x-forward headers>
* secure : <true/false, verify SSL certificate>
* }
*
* NOTE: `options.ws` and `options.ssl` are optional.
* `options.target and `options.forward` cannot be
* both missing
* }
*
* NOTE: `options.ws` and `options.ssl` are optional.
* `options.target and `options.forward` cannot be
* both missing
* }
*/