Skip to content

Commit

Permalink
doc: add information for IncomingMessage.destroy()
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Trott authored and Myles Borins committed Jul 12, 2016
1 parent bf52c6b commit 4043d41
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,14 @@ socket has closed.
Indicates that the underlying connection was closed.
Just like `'end'`, this event occurs only once per response.

### message.destroy([error])

* `error` {Error}

Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`
is provided, an `'error'` event is emitted and `error` is passed as an argument
to any listeners on the event.

### message.headers

The request/response headers object.
Expand Down

0 comments on commit 4043d41

Please sign in to comment.