Skip to content

Commit 9f51b9e

Browse files
Trotttargos
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 <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 418ae9b commit 9f51b9e

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
@@ -3308,6 +3308,22 @@ Type: Documentation-only
33083308
might result in host name spoofing with unexpected input. These URLs will throw
33093309
an error in future versions of Node.js, as the [WHATWG URL API][] does already.
33103310

3311+
### DEP0171: Setters for `http.IncomingMessage` headers and trailers
3312+
3313+
<!-- YAML
3314+
changes:
3315+
- version:
3316+
- REPLACEME
3317+
pr-url: https://github.com/nodejs/node/pull/45697
3318+
description: Documentation-only deprecation.
3319+
-->
3320+
3321+
Type: Documentation-only
3322+
3323+
In a future version of Node.js, [`message.headers`][],
3324+
[`message.headersDistinct`][], [`message.trailers`][], and
3325+
[`message.trailersDistinct`][] will be read-only.
3326+
33113327
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
33123328
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
33133329
[RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
@@ -3384,7 +3400,11 @@ an error in future versions of Node.js, as the [WHATWG URL API][] does already.
33843400
[`https.get()`]: https.md#httpsgetoptions-callback
33853401
[`https.request()`]: https.md#httpsrequestoptions-callback
33863402
[`message.connection`]: http.md#messageconnection
3403+
[`message.headersDistinct`]: http.md#messageheadersdistinct
3404+
[`message.headers`]: http.md#messageheaders
33873405
[`message.socket`]: http.md#messagesocket
3406+
[`message.trailersDistinct`]: http.md#messagetrailersdistinct
3407+
[`message.trailers`]: http.md#messagetrailers
33883408
[`module.createRequire()`]: module.md#modulecreaterequirefilename
33893409
[`os.networkInterfaces()`]: os.md#osnetworkinterfaces
33903410
[`os.tmpdir()`]: os.md#ostmpdir

0 commit comments

Comments
 (0)