Skip to content

Commit b49a5b3

Browse files
mdouglassMyles Borins
authored and
Myles Borins
committed
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: #5993 Reviewed-By: James M Snell <[email protected]>
1 parent 3b00d7a commit b49a5b3

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/api/http.markdown

+7-6
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,13 @@ connection can be reused. In the http agent, this returns
152152
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
153153
socket reusability.
154154

155+
Options:
156+
157+
- `host`: A domain name or IP address of the server to issue the request to.
158+
- `port`: Port of remote server.
159+
- `localAddress`: Local interface to bind for network connections when issuing
160+
the request.
161+
155162
### agent.maxFreeSockets
156163

157164
By default set to 256. For Agents supporting HTTP KeepAlive, this
@@ -303,12 +310,6 @@ the client should send the request body.
303310
Emitted when a response is received to this request. This event is emitted only
304311
once. The `response` argument will be an instance of [`http.IncomingMessage`][].
305312

306-
Options:
307-
308-
- `host`: A domain name or IP address of the server to issue the request to.
309-
- `port`: Port of remote server.
310-
- `socketPath`: Unix Domain Socket (use one of host:port or socketPath)
311-
312313
### Event: 'socket'
313314

314315
`function (socket) { }`

0 commit comments

Comments
 (0)