Skip to content
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 information for IncomingMessage.destroy() #7237

Closed
wants to merge 3 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Jun 8, 2016

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc http

Description of change

Add documentation for http.IncomingMessage.prototype.destroy().

Fixes: #4226

@Trott Trott added http Issues or PRs related to the http subsystem. doc Issues and PRs related to the documentations. labels Jun 8, 2016
* `error` {Error}

Calls `.destroy()` on the socket that received the `IncomingMessage`. If `error`
is provided, an `'error'` event is fired and `error` is passed as an argument to
Copy link
Member

Choose a reason for hiding this comment

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

s/fired/emitted

@jasnell
Copy link
Member

jasnell commented Jun 9, 2016

LGTM with a nit


* `error` {Error}

Calls `.destroy()` on the socket that received the `IncomingMessage`. If `error`
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you remove the . from .destroy()

@cjihrig
Copy link
Contributor

cjihrig commented Jun 9, 2016

LGTM, also with a nit.

Add documentation for `http.IncomingMessage.prototype.destroy()`.

Fixes: nodejs#4226
Trott added a commit to Trott/io.js that referenced this pull request Jun 12, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: nodejs#7237
Fixes: nodejs#4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
@Trott
Copy link
Member Author

Trott commented Jun 12, 2016

Landed in 4f2aec3

@Trott Trott closed this Jun 12, 2016
evanlucas pushed a commit that referenced this pull request Jun 16, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: #7237
Fixes: #4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
@evanlucas evanlucas mentioned this pull request Jun 16, 2016
@MylesBorins
Copy link
Contributor

@Trott is this relevant to v4.x?

@Trott
Copy link
Member Author

Trott commented Jul 12, 2016

@thealphanerd Yes.

addaleax pushed a commit to addaleax/node that referenced this pull request Jul 12, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: nodejs#7237
Fixes: nodejs#4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: #7237
Fixes: #4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: #7237
Fixes: #4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Jul 12, 2016
MylesBorins pushed a commit that referenced this pull request Jul 14, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: #7237
Fixes: #4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Jul 14, 2016
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: #7237
Fixes: #4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
@Trott Trott deleted the destroy branch January 13, 2022 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Why is IncomingMessage.destroy method not documented?
4 participants