Permalink
Browse files

Adding proxy to docs, don't know why this wasn't already in.

  • Loading branch information...
1 parent 8515a51 commit c63e6e96378a2b050bddbe1b39337662f304dc95 @mikeal mikeal committed Aug 12, 2011
Showing with 1 addition and 0 deletions.
  1. +1 −0 README.md
View
@@ -44,6 +44,7 @@ The first argument is an options object. The only required option is uri, all ot
* `pool` - A hash object containing the agents for these requests. If omitted this request will use the global pool which is set to node's default maxSockets.
* `pool.maxSockets` - Integer containing the maximum amount of sockets in the pool.
* `timeout` - Integer containing the number of milliseconds to wait for a request to respond before aborting the request
+* `proxy` - An HTTP proxy to be used. Support proxy Auth with Basic Auth the same way it's supported with the `url` parameter by embedding the auth info in the uri.
The callback argument gets 3 arguments. The first is an error when applicable (usually from the http.Client option not the http.ClientRequest object). The second in an http.ClientResponse object. The third is the response body buffer.

0 comments on commit c63e6e9

Please sign in to comment.