GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc: deprecate (doc-only) http abort related · nodejs/node@4b030d0

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- deprecations.md
- http.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/api/deprecations.md‎`

Copy file name to clipboardExpand all lines: doc/api/deprecations.md

+26Lines changed: 26 additions & 0 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -2838,6 +2838,28 @@ Type: Runtime`
`2838`	`2838`	The remapping of specifiers ending in `"/"` like `import 'pkg/x/'` is deprecated
`2839`	`2839`	for package `"exports"` and `"imports"` pattern resolutions.
`2840`	`2840`
	`2841`	+### DEP0XXX: `.aborted` property and `'abort'`, `'aborted'` event in `http`
	`2842`	`+<!-- YAML`
	`2843`	`+changes:`
	`2844`	`+ - version: REPLACEME`
	`2845`	`+ pr-url: https://github.com/nodejs/node/pull/36670`
	`2846`	`+ description: Documentation-only deprecation.`
	`2847`	`+-->`
	`2848`	`+`
	`2849`	`+Type: Documentation-only`
	`2850`	`+`
	`2851`	+Move to {Stream} API instead, as the [`http.ClientRequest`][],
	`2852`	+[`http.ServerResponse`][], and [`http.IncomingMessage`][] are all stream-based.
	`2853`	+Check `stream.destroyed` instead of the `.aborted` property, and listen for
	`2854`	+`'close'` instead of `'abort'`, `'aborted'` event.
	`2855`	`+`
	`2856`	+The `.aborted` property and `'abort'` event are only useful for detecting
	`2857`	+`.abort()` calls. For closing a request early, use the Stream
	`2858`	+`.destroy([error])` then check the `.destroyed` property and `'close'` event
	`2859`	`+should have the same effect. The receiving end should also check the`
	`2860`	+[`readable.readableEnded`][] value on [`http.IncomingMessage`][] to get whether
	`2861`	`+it was an aborted or graceful destroy.`
	`2862`	`+`
`2841`	`2863`	`[Legacy URL API]: url.md#legacy-url-api`
`2842`	`2864`	`[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf`
`2843`	`2865`	`[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3`
@@ -2895,6 +2917,9 @@ for package `"exports"` and `"imports"` pattern resolutions.
`2895`	`2917`	[`fs.read()`]: fs.md#fsreadfd-buffer-offset-length-position-callback
`2896`	`2918`	[`fs.readSync()`]: fs.md#fsreadsyncfd-buffer-offset-length-position
`2897`	`2919`	[`fs.stat()`]: fs.md#fsstatpath-options-callback
	`2920`	+[`http.ClientRequest`]: http.md#class-httpclientrequest
	`2921`	+[`http.IncomingMessage`]: http.md#class-httpincomingmessage
	`2922`	+[`http.ServerResponse`]: http.md#class-httpserverresponse
`2898`	`2923`	[`http.get()`]: http.md#httpgetoptions-callback
`2899`	`2924`	[`http.request()`]: http.md#httprequestoptions-callback
`2900`	`2925`	[`https.get()`]: https.md#httpsgetoptions-callback
@@ -2907,6 +2932,7 @@ for package `"exports"` and `"imports"` pattern resolutions.
`2907`	`2932`	[`process.env`]: process.md#processenv
`2908`	`2933`	[`process.mainModule`]: process.md#processmainmodule
`2909`	`2934`	[`punycode`]: punycode.md
	`2935`	+[`readable.readableEnded`]: stream.md#readablereadableended
`2910`	`2936`	[`request.abort()`]: http.md#requestabort
`2911`	`2937`	[`request.connection`]: http.md#requestconnection
`2912`	`2938`	[`request.destroy()`]: http.md#requestdestroyerror

Collapse file

`‎doc/api/http.md‎`

Copy file name to clipboardExpand all lines: doc/api/http.md

+14-1Lines changed: 14 additions & 1 deletion

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -407,8 +407,11 @@ body which has been transmitted are equal or not.`
`407`	`407`	### Event: `'abort'`
`408`	`408`	`<!-- YAML`
`409`	`409`	`added: v1.4.1`
	`410`	`+deprecated: REPLACEME`
`410`	`411`	`-->`
`411`	`412`
	`413`	+> Stability: 0 - Deprecated. Listen for the `'close'` event instead.
	`414`	`+`
`412`	`415`	`Emitted when the request has been aborted by the client. This event is only`
`413`	`416`	emitted on the first call to `abort()`.
`414`	`417`
`@@ -564,7 +567,7 @@ added: v0.7.8`
`564`	`567`	`-->`
`565`	`568`
`566`	`569`	`Emitted when the underlying socket times out from inactivity. This only notifies`
`567`		`-that the socket has been idle. The request must be aborted manually.`
	`570`	`+that the socket has been idle. The request must be destroyed manually.`
`568`	`571`
`569`	`572`	See also: [`request.setTimeout()`][].
`570`	`573`
`@@ -645,12 +648,15 @@ in the response to be dropped and the socket to be destroyed.`
`645`	`648`	### `request.aborted`
`646`	`649`	`<!-- YAML`
`647`	`650`	`added: v0.11.14`
	`651`	`+deprecated: REPLACEME`
`648`	`652`	`changes:`
`649`	`653`	`- version: v11.0.0`
`650`	`654`	`pr-url: https://github.com/nodejs/node/pull/20230`
`651`	`655`	description: The `aborted` property is no longer a timestamp number.
`652`	`656`	`-->`
`653`	`657`
	`658`	+> Stability: 0 - Deprecated. Check [`request.destroyed`][] instead.
	`659`	`+`
`654`	`660`	`* {boolean}`
`655`	`661`
`656`	`662`	The `request.aborted` property will be `true` if the request has
`@@ -1988,8 +1994,11 @@ may be reused multiple times in case of keep-alive.`
`1988`	`1994`	### Event: `'aborted'`
`1989`	`1995`	`<!-- YAML`
`1990`	`1996`	`added: v0.3.8`
	`1997`	`+deprecated: REPLACEME`
`1991`	`1998`	`-->`
`1992`	`1999`
	`2000`	+> Stability: 0 - Deprecated. Listen for `'close'` event instead.
	`2001`	`+`
`1993`	`2002`	`Emitted when the request has been aborted.`
`1994`	`2003`
`1995`	`2004`	### Event: `'close'`
`@@ -2002,8 +2011,11 @@ Indicates that the underlying connection was closed.`
`2002`	`2011`	### `message.aborted`
`2003`	`2012`	`<!-- YAML`
`2004`	`2013`	`added: v10.1.0`
	`2014`	`+deprecated: REPLACEME`
`2005`	`2015`	`-->`
`2006`	`2016`
	`2017`	+> Stability: 0 - Deprecated. Check `message.destroyed` from {stream.Readable}.
	`2018`	`+`
`2007`	`2019`	`* {boolean}`
`2008`	`2020`
`2009`	`2021`	The `message.aborted` property will be `true` if the request has
`@@ -3237,6 +3249,7 @@ try {`
`3237`	`3249`	[`outgoingMessage.socket`]: #outgoingmessagesocket
`3238`	`3250`	[`removeHeader(name)`]: #requestremoveheadername
`3239`	`3251`	[`request.destroy()`]: #requestdestroyerror
	`3252`	+[`request.destroyed`]: #requestdestroyed
`3240`	`3253`	[`request.end()`]: #requestenddata-encoding-callback
`3241`	`3254`	[`request.flushHeaders()`]: #requestflushheaders
`3242`	`3255`	[`request.getHeader()`]: #requestgetheadername

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.