Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
55e6663
doc: update http.md mention of socket
jessekoconnor Oct 28, 2019
9eb3fac
docs: correct line spacing
jessekoconnor Oct 28, 2019
8572afb
doc: update stream obj to duplex obj
jessekoconnor Oct 30, 2019
863f6f4
doc: reword socket documentation wording
jessekoconnor Oct 30, 2019
d49e4dd
doc: Capitalize Duplex when referring to class
jessekoconnor Oct 30, 2019
38171e9
doc: update request.keepAlive(duplex)
jessekoconnor Oct 30, 2019
094d513
doc: update the events on Agent first
jessekoconnor Oct 31, 2019
e54b9e9
fix: update rest of events
jessekoconnor Oct 31, 2019
2eec64c
fix: forgot one explanation
jessekoconnor Oct 31, 2019
5b827a3
doc: suggest doc for methods
jessekoconnor Oct 31, 2019
fce5f9c
doc: address rest of relevant methods
jessekoconnor Oct 31, 2019
7cf2e18
doc: suggestion from tniessen
jessekoconnor Nov 1, 2019
da4eec8
Update doc/api/http.md
jessekoconnor Nov 1, 2019
d08c71e
Update doc/api/http.md
jessekoconnor Nov 1, 2019
352fce8
Update doc/api/http.md
jessekoconnor Nov 1, 2019
916b271
Update doc/api/http.md
jessekoconnor Nov 1, 2019
8f39b79
Update doc/api/http.md
jessekoconnor Nov 1, 2019
f1419f3
Update doc/api/http.md
jessekoconnor Nov 1, 2019
92bbaec
Update doc/api/http.md
jessekoconnor Nov 1, 2019
b545157
doc: wording suggestion from tniessen
jessekoconnor Nov 1, 2019
220cecb
doc: more tidying up
jessekoconnor Nov 1, 2019
92fbdef
doc: even more tidying up
jessekoconnor Nov 1, 2019
6809c26
fix: update further
jessekoconnor Nov 1, 2019
14cf7aa
Update doc/api/http.md
jessekoconnor Nov 3, 2019
1fc5adf
doc: Updates based on feedback from tniesson
jessekoconnor Nov 4, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: update request.keepAlive(duplex)
  • Loading branch information
jessekoconnor committed Oct 30, 2019
commit 38171e9d02bf1295fd3d97de7b3900451fa1c12f
10 changes: 7 additions & 3 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,14 +169,14 @@ socket/stream from this function, or by passing the socket/stream to `callback`.

`callback` has a signature of `(err, stream)`.

### agent.keepSocketAlive(socket)
### agent.keepSocketAlive(duplex)
<!-- YAML
added: v8.1.0
-->

* `socket` {net.Socket}
* `duplex` {stream.Duplex}

Called when `socket` is detached from a request and could be persisted by the
Called when socket is detached from a request and could be persisted by the
`Agent`. Default behavior is to:

```js
Expand All @@ -185,6 +185,10 @@ socket.unref();
return true;
```

This event is guaranteed to be passed an instance of the {net.Socket} class,
a subclass of Duplex, unless the user specifies a socket type other than
{net.Socket}.

This method can be overridden by a particular `Agent` subclass. If this
method returns a falsy value, the socket will be destroyed instead of persisting
it for use with the next request.
Expand Down