Skip to content

doc: update http.md mention of socket #30155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jessekoconnor wants to merge 25 commits into from
Closed

doc: update http.md mention of socket #30155

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: address rest of relevant methods
  • Loading branch information
@jessekoconnor
jessekoconnor committed Oct 31, 2019
commit fce5f9ca56c8231a810d79d17167d63ac1574669
12 changes: 11 additions & 1 deletion doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,8 @@ 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.

`socket` can be an instance of {stream.Duplex} which is a superclass of Socket.
`socket` argument can be an instance of {stream.Duplex}, a superclass of
Comment thread
tniessen marked this conversation as resolved.
Outdated
Socket.
Comment thread
jessekoconnor marked this conversation as resolved.
Outdated

### agent.reuseSocket(socket, request)
<!-- YAML
Expand All @@ -208,6 +209,9 @@ socket.ref();

This method can be overridden by a particular `Agent` subclass.

`socket` argument can be an instance of {stream.Duplex}, a superclass of
Comment thread
tniessen marked this conversation as resolved.
Outdated
Socket.
Comment thread
jessekoconnor marked this conversation as resolved.
Outdated

### agent.destroy()
<!-- YAML
added: v0.11.4
Expand Down Expand Up @@ -834,6 +838,8 @@ req.once('response', (res) => {
});
```

Can be passed an instance of {stream.Duplex}, a superclass of Socket.

@tniessen tniessen Nov 1, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the type of the property be changed to {stream.Duplex}?

Also, "Can be passed" doesn't sound right for a property that is not a function.


### request.writableEnded
<!-- YAML
added: v12.9.0
Expand Down Expand Up @@ -1507,6 +1513,8 @@ const server = http.createServer((req, res) => {
}).listen(3000);
```

Can be passsed an instance of {stream.Duplex}, a superclass of Socket.
Comment thread
tniessen marked this conversation as resolved.
Outdated

### response.statusCode
<!-- YAML
added: v0.4.0
Expand Down Expand Up @@ -1885,6 +1893,8 @@ The [`net.Socket`][] object associated with the connection.
With HTTPS support, use [`request.socket.getPeerCertificate()`][] to obtain the
client's authentication details.

Can be passed an instance of {stream.Duplex}, a superclass of Socket.
Comment thread
tniessen marked this conversation as resolved.
Outdated

### message.statusCode
<!-- YAML
added: v0.1.1
Expand Down