Permalink
Browse files

doc: clarify http.get data consumption requirement

With the previous wording, I read this sentence as meaning, "you
_must_ use the http.get callback mechanism and cannot register a
listener on the returned http.ClientRequest object." This is obviously
not the intention, so adjust the sentence to make this clearer.

PR-URL: #15049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
strugee authored and MylesBorins committed Aug 26, 2017
1 parent e014178 commit 5696223534542fd0818f7f67c3a6e75a7b6d1863
Showing with 2 additions and 2 deletions.
  1. +2 −2 doc/api/http.md
View
@@ -1476,8 +1476,8 @@ added: v0.3.6
Since most requests are GET requests without bodies, Node.js provides this
convenience method. The only difference between this method and
[`http.request()`][] is that it sets the method to GET and calls `req.end()`
automatically. Note that response data must be consumed in the callback
for reasons stated in [`http.ClientRequest`][] section.
automatically. Note that the callback must take care to consume the response
data for reasons stated in [`http.ClientRequest`][] section.
The `callback` is invoked with a single argument that is an instance of
[`http.IncomingMessage`][]

0 comments on commit 5696223

Please sign in to comment.