-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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.
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
doc: add document for http.OutgoingMessage #37265
Conversation
OutgoingMessage is a very old feature which is exported to public in http module dated to v0.1.x. But it is not documented at all. This commit adds document for http.OutgogingMessage. Fixes: nodejs#33847
@nodejs/documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grammer fixes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These suggestions simply improve the grammar.
@jasnell, are these changes necessary or may be ignored?
I would apply the suggestions. Grammar improvements are always a good thing ;) |
@marsonya Thank you for reviewing, I will process your suggestions tonight. (GMT+8) |
OutgoingMessage is a very old feature which is exported to public in http module dated to v0.1.x. But it is not documented at all. This commit adds document for http.OutgogingMessage. Fixes: #33847 PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Landed in c347f23...648696b 🎉 |
I'm having trouble landing this in this week's 15.x because of a linting error here: 53b673e#diff-d692ac4524379ec6a1201165e8ff8d3267c8130e07014e8221ebf7e6f80c6641R3144. This is the error I get locally:
I tried to switch |
OutgoingMessage is a very old feature which is exported to public in http module dated to v0.1.x. But it is not documented at all. This commit adds document for http.OutgogingMessage. Fixes: #33847 PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
OutgoingMessage is a very old feature which is exported to public in http module dated to v0.1.x. But it is not documented at all. This commit adds document for http.OutgogingMessage. Fixes: #33847 PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
OutgoingMessage is a very old feature which is exported to public in http module dated to v0.1.x. But it is not documented at all. This commit adds document for http.OutgogingMessage. Fixes: #33847 PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
OutgoingMessage is a very old feature which is exported to public in http module dated to v0.1.x. But it is not documented at all. This commit adds document for http.OutgogingMessage. Fixes: #33847 PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: #37265 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Robert Nagy <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
This PR adds document for
http.OutgoingMessage
, therefore, fix #33847.I'm not sure what should be a part of public API, and assume that methods and properties without
_
prefix. are part of public API.The
http.OutgoingMessage
serves as the parent class ofhttp.ClientRequest
andhttp.ServerResponse
. I copy-and-pasted many document from them.