Skip to content

Commit

Permalink
Merge pull request #536 from nodejitsu/caronte-api
Browse files Browse the repository at this point in the history
export the proxy itself from the main require
  • Loading branch information
yawnt committed Dec 28, 2013
2 parents e599151 + 6fa23e1 commit c17b591
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions lib/http-proxy.js
@@ -1,8 +1,12 @@
var http = require('http'),
https = require('https'),
url = require('url'),
httpProxy = require('./http-proxy/'),
proxy = exports;
httpProxy = require('./http-proxy/');

/**
* Export the the proxy "Server" as the main export
*/
module.exports = httpProxy.Server;

/**
* Creates the proxy server.
Expand All @@ -19,23 +23,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
* }
*/

Expand Down

0 comments on commit c17b591

Please sign in to comment.