Skip to content

Commit 86996c5

Browse files
committed
doc: deprecate private http properties
PR-URL: #10941 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
1 parent 74bd314 commit 86996c5

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/api/deprecations.md

+26
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,32 @@ The `NODE_REPL_MODE` environment variable is used to set the underlying
556556
`replMode` of an interactive `node` session. Its default value, `magic`, is
557557
similarly deprecated in favor of `sloppy`.
558558

559+
<a id="DEP0066"></a>
560+
### DEP0066: outgoingMessage.\_headers, outgoingMessage.\_headerNames
561+
562+
Type: Documentation-only
563+
564+
The `http` module `outgoingMessage._headers` and `outgoingMessage._headerNames`
565+
properties have been deprecated. Please instead use one of the public methods
566+
(e.g. `outgoingMessage.getHeader()`, `outgoingMessage.getHeaders()`,
567+
`outgoingMessage.getHeaderNames()`, `outgoingMessage.hasHeader()`,
568+
`outgoingMessage.removeHeader()`, `outgoingMessage.setHeader()`) for working
569+
with outgoing headers.
570+
571+
*Note*: `outgoingMessage._headers` and `outgoingMessage._headerNames` were never
572+
documented as officially supported properties.
573+
574+
<a id="DEP0067"></a>
575+
### DEP0067: OutgoingMessage.prototype.\_renderHeaders
576+
577+
Type: Documentation-only
578+
579+
The `http` module `OutgoingMessage.prototype._renderHeaders()` API has been
580+
deprecated.
581+
582+
*Note*: `OutgoingMessage.prototype._renderHeaders` was never documented as
583+
an officially supported API.
584+
559585
[alloc]: buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding
560586
[alloc_unsafe_size]: buffer.html#buffer_class_method_buffer_allocunsafe_size
561587
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size

0 commit comments

Comments
 (0)