diff options
| author | Kip Gebhardt <kip.gebhardt@voxer.com> | 2011-06-28 23:50:42 +0400 |
|---|---|---|
| committer | koichik <koichik@improvement.jp> | 2011-07-13 23:06:46 +0400 |
| commit | 7097eca5a76cc169fcd6e927a15dcd879fb61c0c (patch) | |
| tree | 6288d18b59c1cf80eeb203cba96fed28e9fca708 /doc | |
| parent | 5208abe7237a4840957072e4445a543515223e91 (diff) | |
Adding documentation for 'agent' option in http.request().
Fixes #1243.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http.markdown | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/http.markdown b/doc/api/http.markdown index 153b8e80244..7fe52403a59 100644 --- a/doc/api/http.markdown +++ b/doc/api/http.markdown @@ -393,6 +393,10 @@ Options: - `path`: Request path. Should include query string and fragments if any. E.G. `'/index.html?page=12'` - `headers`: An object containing request headers. +- `agent`: Controls `Agent` behavior. Possible values: + - `undefined` (default): use default `Agent` for this host and port. + - `Agent` object: explicitly use the passed in `Agent`. + - `false`: explicitly generate a new `Agent` for this host and port. `Agent` will not be re-used. `http.request()` returns an instance of the `http.ClientRequest` class. The `ClientRequest` instance is a writable stream. If one needs to |