Skip to content

Commit 0dbdda5

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 34b64b3 commit 0dbdda5

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/api/http.markdown

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,13 @@ connection can be reused. In the http agent, this returns
140140
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
141141
socket reusability.
142142

143+
Options:
144+
145+
- `host`: A domain name or IP address of the server to issue the request to.
146+
- `port`: Port of remote server.
147+
- `localAddress`: Local interface to bind for network connections when issuing
148+
the request.
149+
143150
### agent.maxFreeSockets
144151

145152
By default set to 256. For Agents supporting HTTP KeepAlive, this
@@ -280,12 +287,6 @@ the client should send the request body.
280287
Emitted when a response is received to this request. This event is emitted only
281288
once. The `response` argument will be an instance of [`http.IncomingMessage`][].
282289

283-
Options:
284-
285-
- `host`: A domain name or IP address of the server to issue the request to.
286-
- `port`: Port of remote server.
287-
- `socketPath`: Unix Domain Socket (use one of host:port or socketPath)
288-
289290
### Event: 'socket'
290291

291292
`function (socket) { }`

0 commit comments

Comments
 (0)