Skip to content

Commit 1b5fb1d

Browse files
committed
DOC: updated readme with options
1 parent 12cda56 commit 1b5fb1d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,14 @@ server.listen(5050);
105105

106106
* **target**: url string to be parsed with the url module
107107
* **forward**: url string to be parsed with the url module
108+
* **agent**: object to be passed to http(s).request (see Node's [https agent][0] and [http agent][1] agent objects)
109+
110+
If you are using the `proxyServer.listen` method, the following options are also applicable:
111+
108112
* **ssl**: object to be passed to https.createServer()
109113
* **ws**: true/false, if you want to proxy websockets
110114
* **xfwd**: true/false, adds x-forward headers
111-
* **maxSock**: maximum number of sockets
115+
112116

113117
### Test
114118

@@ -144,3 +148,5 @@ Logo created by [Diego Pasquali](http://dribbble.com/diegopq)
144148
>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
145149
>THE SOFTWARE.
146150
151+
[0]: http://nodejs.org/api/https.html#https_class_https_agent
152+
[1]: http://nodejs.org/api/http.html#http_class_http_agent

0 commit comments

Comments
 (0)