Skip to content

Commit 1e6d7da

Browse files
mcollinaaduh95
andcommitted
doc: deprecate HTTP/2 priority signaling
Signed-off-by: Matteo Collina <[email protected]> Co-authored-by: Antoine du Hamel <[email protected]> PR-URL: #58313 Backport-PR-URL: #58542 Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Tim Perry <[email protected]>
1 parent f84998d commit 1e6d7da

File tree

2 files changed

+54
-2
lines changed

2 files changed

+54
-2
lines changed

doc/api/deprecations.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3766,10 +3766,54 @@ of built-in modules. This was incomplete and matched the already deprecated
37663766
`repl._builtinLibs` ([DEP0142][]) instead it's better to rely
37673767
upon `require('node:module').builtinModules`.
37683768

3769+
### DEP0192: `require('node:_tls_common')` and `require('node:_tls_wrap')`
3770+
3771+
<!-- YAML
3772+
changes:
3773+
- version: REPLACEME
3774+
pr-url: https://github.com/nodejs/node/pull/57643
3775+
description: Documentation-only deprecation.
3776+
-->
3777+
3778+
Type: Documentation-only
3779+
3780+
The `node:_tls_common` and `node:_tls_wrap` modules are deprecated as they should be considered
3781+
an internal nodejs implementation rather than a public facing API, use `node:tls` instead.
3782+
3783+
### DEP0193: `require('node:_stream_*')`
3784+
3785+
<!-- YAML
3786+
changes:
3787+
- version: REPLACEME
3788+
pr-url: https://github.com/nodejs/node/pull/58337
3789+
description: Documentation-only deprecation.
3790+
-->
3791+
3792+
Type: Documentation-only
3793+
3794+
The `node:_stream_duplex`, `node:_stream_passthrough`, `node:_stream_readable`, `node:_stream_transform`,
3795+
`node:_stream_wrap` and `node:_stream_writable` modules are deprecated as they should be considered
3796+
an internal nodejs implementation rather than a public facing API, use `node:stream` instead.
3797+
3798+
### DEP0194: `require('node:http2').Http2Stream.priority`
3799+
3800+
<!-- YAML
3801+
changes:
3802+
- version: REPLACEME
3803+
pr-url: https://github.com/nodejs/node/pull/58313
3804+
description: Documentation-only deprecation.
3805+
-->
3806+
3807+
Type: Documentation-only
3808+
3809+
The support for priority signaling has been deprecated in the [RFC 9113][], and
3810+
will be removed in future versions of Node.js.
3811+
37693812
[DEP0142]: #dep0142-repl_builtinlibs
37703813
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
37713814
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
37723815
[RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
3816+
[RFC 9113]: https://datatracker.ietf.org/doc/html/rfc9113#section-5.3.1
37733817
[WHATWG URL API]: url.md#the-whatwg-url-api
37743818
[`"exports"` or `"main"` entry]: packages.md#main-entry-point-export
37753819
[`'uncaughtException'`]: process.md#event-uncaughtexception

doc/api/http2.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1457,6 +1457,7 @@ numeric stream identifier.
14571457

14581458
<!-- YAML
14591459
added: v8.4.0
1460+
deprecated: REPLACEME
14601461
-->
14611462

14621463
* `options` {Object}
@@ -1474,6 +1475,9 @@ added: v8.4.0
14741475

14751476
Updates the priority for this `Http2Stream` instance.
14761477

1478+
The support for priority signaling has been deprecated in the [RFC 9113][], and
1479+
will be removed in future versions of Node.js.
1480+
14771481
#### `http2stream.rstCode`
14781482

14791483
<!-- YAML
@@ -1583,8 +1587,11 @@ Provides miscellaneous information about the current state of the
15831587
remotely.
15841588
* `sumDependencyWeight` {number} The sum weight of all `Http2Stream`
15851589
instances that depend on this `Http2Stream` as specified using
1586-
`PRIORITY` frames.
1587-
* `weight` {number} The priority weight of this `Http2Stream`.
1590+
`PRIORITY` frames. This has been **deprecated** in [RFC 9113][], and
1591+
support for it will be removed in future versions of Node.js.
1592+
* `weight` {number} The priority weight of this `Http2Stream`. This has been
1593+
**deprecated** in [RFC 9113][], and support for it will be removed in future
1594+
versions of Node.js.
15881595

15891596
A current state of this `Http2Stream`.
15901597

@@ -4880,6 +4887,7 @@ you need to implement any fall-back behavior yourself.
48804887
[RFC 7838]: https://tools.ietf.org/html/rfc7838
48814888
[RFC 8336]: https://tools.ietf.org/html/rfc8336
48824889
[RFC 8441]: https://tools.ietf.org/html/rfc8441
4890+
[RFC 9113]: https://datatracker.ietf.org/doc/html/rfc9113#section-5.3.1
48834891
[Sensitive headers]: #sensitive-headers
48844892
[`'checkContinue'`]: #event-checkcontinue
48854893
[`'connect'`]: #event-connect

0 commit comments

Comments
 (0)