Commit 0b2ba44
doc: clarify http error events after calling destroy()
PR-URL: #46903
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 9ecf2a4 commit 0b2ba44
1 file changed
Lines changed: 9 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3644,7 +3644,7 @@ the following events will be emitted in the following order: | |||
| 3644 | 3644 | * (connection closed here) | |
| 3645 | 3645 | * `'aborted'` on the `res` object | |
| 3646 | 3646 | * `'error'` on the `res` object with an error with message | |
| 3647 | - `'Error: aborted'` and code `'ECONNRESET'`. | ||
| 3647 | + `'Error: aborted'` and code `'ECONNRESET'` | ||
| 3648 | 3648 | * `'close'` | |
| 3649 | 3649 | * `'close'` on the `res` object | |
| 3650 | 3650 | ||
@@ -3653,7 +3653,7 @@ events will be emitted in the following order: | |||
| 3653 | 3653 | ||
| 3654 | 3654 | * (`req.destroy()` called here) | |
| 3655 | 3655 | * `'error'` with an error with message `'Error: socket hang up'` and code | |
| 3656 | - `'ECONNRESET'` | ||
| 3656 | + `'ECONNRESET'`, or the error with which `req.destroy()` was called | ||
| 3657 | 3657 | * `'close'` | |
| 3658 | 3658 | ||
| 3659 | 3659 | If `req.destroy()` is called before the connection succeeds, the following | |
@@ -3662,7 +3662,7 @@ events will be emitted in the following order: | |||
| 3662 | 3662 | * `'socket'` | |
| 3663 | 3663 | * (`req.destroy()` called here) | |
| 3664 | 3664 | * `'error'` with an error with message `'Error: socket hang up'` and code | |
| 3665 | - `'ECONNRESET'` | ||
| 3665 | + `'ECONNRESET'`, or the error with which `req.destroy()` was called | ||
| 3666 | 3666 | * `'close'` | |
| 3667 | 3667 | ||
| 3668 | 3668 | If `req.destroy()` is called after the response is received, the following | |
@@ -3673,8 +3673,8 @@ events will be emitted in the following order: | |||
| 3673 | 3673 | * `'data'` any number of times, on the `res` object | |
| 3674 | 3674 | * (`req.destroy()` called here) | |
| 3675 | 3675 | * `'aborted'` on the `res` object | |
| 3676 | - * `'error'` on the `res` object with an error with message | ||
| 3677 | - `'Error: aborted'` and code `'ECONNRESET'`. | ||
| 3676 | + * `'error'` on the `res` object with an error with message `'Error: aborted'` | ||
| 3677 | + and code `'ECONNRESET'`, or the error with which `req.destroy()` was called | ||
| 3678 | 3678 | * `'close'` | |
| 3679 | 3679 | * `'close'` on the `res` object | |
| 3680 | 3680 | ||
@@ -3712,9 +3712,11 @@ events will be emitted in the following order: | |||
| 3712 | 3712 | Setting the `timeout` option or using the `setTimeout()` function will | |
| 3713 | 3713 | not abort the request or do anything besides add a `'timeout'` event. | |
| 3714 | 3714 | ||
| 3715 | - Passing an `AbortSignal` and then calling `abort` on the corresponding | ||
| 3715 | + Passing an `AbortSignal` and then calling `abort()` on the corresponding | ||
| 3716 | 3716 | `AbortController` will behave the same way as calling `.destroy()` on the | |
| 3717 | - request itself. | ||
| 3717 | + request. Specifically, the `'error'` event will be emitted with an error with | ||
| 3718 | + the message `'AbortError: The operation was aborted'`, the code `'ABORT_ERR'` | ||
| 3719 | + and the `cause`, if one was provided. | ||
| 3718 | 3720 | ||
| 3719 | 3721 | ## `http.validateHeaderName(name[, label])` | |
| 3720 | 3722 | ||
0 commit comments