Commit 60c054b
doc: add information for IncomingMessage.destroy()
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>1 parent 1a5c025 commit 60c054b
1 file changed
Lines changed: 8 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -874,6 +874,14 @@ socket has closed. | |||
| 874 | 874 | Indicates that the underlying connection was closed. | |
| 875 | 875 | Just like `'end'`, this event occurs only once per response. | |
| 876 | 876 | ||
| 877 | + ### message.destroy([error]) | ||
| 878 | + | ||
| 879 | + * `error` {Error} | ||
| 880 | + | ||
| 881 | + Calls `destroy()` on the socket that received the `IncomingMessage`. If `error` | ||
| 882 | + is provided, an `'error'` event is emitted and `error` is passed as an argument | ||
| 883 | + to any listeners on the event. | ||
| 884 | + | ||
| 877 | 885 | ### message.headers | |
| 878 | 886 | ||
| 879 | 887 | The request/response headers object. | |
0 commit comments