Commit 5ae5ca9
doc: add http.IncomingMessage#connection
Refs: #33715
* link message.socket
* deprecate
* update doc/api/http.md
PR-URL: #33768
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>1 parent d8f535b commit 5ae5ca9
2 files changed
Lines changed: 26 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2699,6 +2699,19 @@ resolutions not in `node_modules`. This means there will not be deprecation | |||
| 2699 | 2699 | warnings for `"exports"` in dependencies. With `--pending-deprecation`, a | |
| 2700 | 2700 | runtime warning results no matter where the `"exports"` usage occurs. | |
| 2701 | 2701 | ||
| 2702 | + <a id="DEP0148"></a> | ||
| 2703 | + ### DEP0148: `http.IncomingMessage#connection` | ||
| 2704 | + <!-- YAML | ||
| 2705 | + changes: | ||
| 2706 | + - version: REPLACEME | ||
| 2707 | + pr-url: https://github.com/nodejs/node/pull/33768 | ||
| 2708 | + description: Documentation-only deprecation. | ||
| 2709 | + --> | ||
| 2710 | + | ||
| 2711 | + Type: Documentation-only. | ||
| 2712 | + | ||
| 2713 | + Prefer [`message.socket`][] over [`message.connection`][]. | ||
| 2714 | + | ||
| 2702 | 2715 | [Legacy URL API]: url.md#url_legacy_url_api | |
| 2703 | 2716 | [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf | |
| 2704 | 2717 | [RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 | |
@@ -2757,6 +2770,8 @@ runtime warning results no matter where the `"exports"` usage occurs. | |||
| 2757 | 2770 | [`http.request()`]: http.md#http_http_request_options_callback | |
| 2758 | 2771 | [`https.get()`]: https.md#https_https_get_options_callback | |
| 2759 | 2772 | [`https.request()`]: https.md#https_https_request_options_callback | |
| 2773 | + [`message.connection`]: http.md#http_message_connection | ||
| 2774 | + [`message.socket`]: http.md#http_message_socket | ||
| 2760 | 2775 | [`module.createRequire()`]: module.md#module_module_createrequire_filename | |
| 2761 | 2776 | [`os.networkInterfaces()`]: os.md#os_os_networkinterfaces | |
| 2762 | 2777 | [`os.tmpdir()`]: os.md#os_os_tmpdir | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1984,6 +1984,16 @@ const req = http.request({ | |||
| 1984 | 1984 | }); | |
| 1985 | 1985 | ``` | |
| 1986 | 1986 | ||
| 1987 | + ### `message.connection` | ||
| 1988 | + <!-- YAML | ||
| 1989 | + added: v0.1.90 | ||
| 1990 | + deprecated: REPLACEME | ||
| 1991 | + --> | ||
| 1992 | + | ||
| 1993 | + > Stability: 0 - Deprecated. Use [`message.socket`][]. | ||
| 1994 | + | ||
| 1995 | + Alias for [`message.socket`][]. | ||
| 1996 | + | ||
| 1987 | 1997 | ### `message.destroy([error])` | |
| 1988 | 1998 | <!-- YAML | |
| 1989 | 1999 | added: v0.3.0 | |
@@ -2742,6 +2752,7 @@ try { | |||
| 2742 | 2752 | [`net.Socket`]: net.md#net_class_net_socket | |
| 2743 | 2753 | [`net.createConnection()`]: net.md#net_net_createconnection_options_connectlistener | |
| 2744 | 2754 | [`new URL()`]: url.md#url_new_url_input_base | |
| 2755 | + [`message.socket`]: #http_message_socket | ||
| 2745 | 2756 | [`removeHeader(name)`]: #http_request_removeheader_name | |
| 2746 | 2757 | [`request.end()`]: #http_request_end_data_encoding_callback | |
| 2747 | 2758 | [`request.destroy()`]: #http_request_destroy_error | |
0 commit comments