Skip to content

Commit 8203c02

Browse files
Trottdanielleadams
authored andcommitted
doc: add doc-only deprecation for headers/trailers setters
The headers and trailers for http.IncomingMessage will be read-only in a future version of Node.js. Ref: #45571 PR-URL: #45697 Refs: #45571 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 79b3ee1 commit 8203c02

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/api/deprecations.md

+20
Original file line numberDiff line numberDiff line change
@@ -3299,6 +3299,22 @@ Type: Documentation-only
32993299
might result in host name spoofing with unexpected input. These URLs will throw
33003300
an error in future versions of Node.js, as the [WHATWG URL API][] does already.
33013301

3302+
### DEP0171: Setters for `http.IncomingMessage` headers and trailers
3303+
3304+
<!-- YAML
3305+
changes:
3306+
- version:
3307+
- REPLACEME
3308+
pr-url: https://github.com/nodejs/node/pull/45697
3309+
description: Documentation-only deprecation.
3310+
-->
3311+
3312+
Type: Documentation-only
3313+
3314+
In a future version of Node.js, [`message.headers`][],
3315+
[`message.headersDistinct`][], [`message.trailers`][], and
3316+
[`message.trailersDistinct`][] will be read-only.
3317+
33023318
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
33033319
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
33043320
[RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
@@ -3375,7 +3391,11 @@ an error in future versions of Node.js, as the [WHATWG URL API][] does already.
33753391
[`https.get()`]: https.md#httpsgetoptions-callback
33763392
[`https.request()`]: https.md#httpsrequestoptions-callback
33773393
[`message.connection`]: http.md#messageconnection
3394+
[`message.headersDistinct`]: http.md#messageheadersdistinct
3395+
[`message.headers`]: http.md#messageheaders
33783396
[`message.socket`]: http.md#messagesocket
3397+
[`message.trailersDistinct`]: http.md#messagetrailersdistinct
3398+
[`message.trailers`]: http.md#messagetrailers
33793399
[`module.createRequire()`]: module.md#modulecreaterequirefilename
33803400
[`os.networkInterfaces()`]: os.md#osnetworkinterfaces
33813401
[`os.tmpdir()`]: os.md#ostmpdir

0 commit comments

Comments
 (0)