From ed8bff782518029f973c19bd6d9c68da0450bf00 Mon Sep 17 00:00:00 2001 From: Matthew Douglass Date: Thu, 31 Mar 2016 22:59:21 -0700 Subject: [PATCH] doc: fix http response event, Agent#getName Removes the options block from the http 'response' event and attaches it to Agent#getName where it belongs. Removes socketPath and documents localAddress option. PR-URL: https://github.com/nodejs/node/pull/5993 Reviewed-By: James M Snell --- doc/api/http.markdown | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/api/http.markdown b/doc/api/http.markdown index 0a16435b45d2f7..00eb188c94aa27 100644 --- a/doc/api/http.markdown +++ b/doc/api/http.markdown @@ -140,6 +140,13 @@ connection can be reused. In the http agent, this returns CA, cert, ciphers, and other HTTPS/TLS-specific options that determine socket reusability. +Options: + +- `host`: A domain name or IP address of the server to issue the request to. +- `port`: Port of remote server. +- `localAddress`: Local interface to bind for network connections when issuing + the request. + ### agent.maxFreeSockets By default set to 256. For Agents supporting HTTP KeepAlive, this @@ -280,12 +287,6 @@ the client should send the request body. Emitted when a response is received to this request. This event is emitted only once. The `response` argument will be an instance of [`http.IncomingMessage`][]. -Options: - -- `host`: A domain name or IP address of the server to issue the request to. -- `port`: Port of remote server. -- `socketPath`: Unix Domain Socket (use one of host:port or socketPath) - ### Event: 'socket' `function (socket) { }`