Skip to content

http: deprecate aborted property and event #33345

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.

Sign up for GitHub

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

Closed
ronag wants to merge 2 commits into from
Closed

http: deprecate aborted property and event #33345

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
304935f
http: deprecate aborted property and event
ronag May 10, 2020
73beedc
fixup
ronag May 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup
  • Loading branch information
@ronag
ronag committed May 11, 2020
commit 73beedc750c8ed8418b8c50394d6761695e04a64
10 changes: 9 additions & 1 deletion doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2680,7 +2680,12 @@ changes:

Type: Documentation-only

Use [`request.destroyed`][] instead of [`request.aborted`][].
Use [`request.destroyed`][] and [`request.readableEnded`][] instead of
[`request.aborted`][].

```js
const aborted = request.destroyed && !request.readableEnded
```

<a id="DEP0XXX"></a>
### DEP0XX: Use `'error'` event instead of `'aborted'`
Expand Down Expand Up @@ -2757,10 +2762,13 @@ Use `'error'` event instead of `'aborted'`.
[`punycode`]: punycode.html
[`require.extensions`]: modules.html#modules_require_extensions
[`require.main`]: modules.html#modules_accessing_the_main_module
[`request.aborted`]: http.html#http_request_aborted
[`request.abort()`]: http.html#http_request_abort
[`request.socket`]: http.html#http_request_socket
[`request.connection`]: http.html#http_request_connection
[`request.destroyed`]: http.html#http_request_destroyed
[`request.destroy()`]: http.html#http_request_destroy_error
[`request.readableEnded`]: http.html#http_request_readableended
[`response.socket`]: http.html#http_response_socket
[`response.connection`]: http.html#http_response_connection
[`response.end()`]: http.html#http_response_end_data_encoding_callback
Expand Down
10 changes: 9 additions & 1 deletion doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,8 @@ changes:
- REPLACEME
-->

> Stability: 0 - Deprecated: Use [`request.destroyed`][] instead.
> Stability: 0 - Deprecated: Use [`request.destroyed`][] and
[`request.readableEnded`][] instead.

* {boolean}

Expand Down Expand Up @@ -1822,10 +1823,15 @@ Indicates that the underlying connection was closed.
### `message.aborted`
<!-- YAML
added: v10.1.0
deprecated:
- REPLACEME
-->

* {boolean}

> Stability: 0 - Deprecated: Use [`message.destroyed`][] and
[`message.readableEnded`][] instead.

The `message.aborted` property will be `true` if the request has
been aborted.

Expand Down Expand Up @@ -2597,10 +2603,12 @@ try {
[`removeHeader(name)`]: #http_request_removeheader_name
[`request.end()`]: #http_request_end_data_encoding_callback
[`request.destroy()`]: #http_request_destroy_error
[`request.destroyed`]: #http_request_destroyed
[`request.flushHeaders()`]: #http_request_flushheaders
[`request.getHeader()`]: #http_request_getheader_name
[`request.setHeader()`]: #http_request_setheader_name_value
[`request.setTimeout()`]: #http_request_settimeout_timeout_callback
[`request.readableEnded`]: #http_request_readableended
[`request.socket.getPeerCertificate()`]: tls.html#tls_tlssocket_getpeercertificate_detailed
[`request.socket`]: #http_request_socket
[`request.writableFinished`]: #http_request_writablefinished
Expand Down