Commit 19a6636
doc: clarify DEP0194 scope
Since priority signaling covers more than `http2Stream.priority`,
it makes more sense to rename the section.
There were also a few missing mentions in `http2.md`.
PR-URL: #58504
Backport-PR-URL: #58542
Refs: #58313
Reviewed-By: Tim Perry <pimterry@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent db68cec commit 19a6636
2 files changed
Lines changed: 16 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3626,7 +3626,7 @@ The `node:_stream_duplex`, `node:_stream_passthrough`, `node:_stream_readable`, | |||
| 3626 | 3626 | `node:_stream_wrap` and `node:_stream_writable` modules are deprecated as they should be considered | |
| 3627 | 3627 | an internal nodejs implementation rather than a public facing API, use `node:stream` instead. | |
| 3628 | 3628 | ||
| 3629 | - ### DEP0194: `require('node:http2').Http2Stream.priority` | ||
| 3629 | + ### DEP0194: HTTP/2 priority signaling | ||
| 3630 | 3630 | ||
| 3631 | 3631 | <!-- YAML | |
| 3632 | 3632 | changes: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1071,6 +1071,11 @@ The `'origin'` event is only emitted when using a secure TLS connection. | |||
| 1071 | 1071 | ||
| 1072 | 1072 | <!-- YAML | |
| 1073 | 1073 | added: v8.4.0 | |
| 1074 | + changes: | ||
| 1075 | + - version: REPLACEME | ||
| 1076 | + pr-url: https://github.com/nodejs/node/pull/58313 | ||
| 1077 | + description: Following the deprecation of priority signaling as of RFC 1993, | ||
| 1078 | + `weight` option is deprecated. | ||
| 1074 | 1079 | --> | |
| 1075 | 1080 | ||
| 1076 | 1081 | * `headers` {HTTP/2 Headers Object} | |
@@ -1087,7 +1092,8 @@ added: v8.4.0 | |||
| 1087 | 1092 | created stream is dependent on. | |
| 1088 | 1093 | * `weight` {number} Specifies the relative dependency of a stream in relation | |
| 1089 | 1094 | to other streams with the same `parent`. The value is a number between `1` | |
| 1090 | - and `256` (inclusive). | ||
| 1095 | + and `256` (inclusive). This has been **deprecated** in [RFC 9113][], and | ||
| 1096 | + support for it will be removed in future versions of Node.js. | ||
| 1091 | 1097 | * `waitForTrailers` {boolean} When `true`, the `Http2Stream` will emit the | |
| 1092 | 1098 | `'wantTrailers'` event after the final `DATA` frame has been sent. | |
| 1093 | 1099 | * `signal` {AbortSignal} An AbortSignal that may be used to abort an ongoing | |
@@ -1460,6 +1466,9 @@ added: v8.4.0 | |||
| 1460 | 1466 | deprecated: REPLACEME | |
| 1461 | 1467 | --> | |
| 1462 | 1468 | ||
| 1469 | + > Stability: 0 - Deprecated: support for priority signaling has been deprecated | ||
| 1470 | + > in the [RFC 9113][] and is no longer supported in Node.js. | ||
| 1471 | + | ||
| 1463 | 1472 | * `options` {Object} | |
| 1464 | 1473 | * `exclusive` {boolean} When `true` and `parent` identifies a parent Stream, | |
| 1465 | 1474 | this stream is made the sole direct dependency of the parent, with | |
@@ -1475,9 +1484,6 @@ deprecated: REPLACEME | |||
| 1475 | 1484 | ||
| 1476 | 1485 | Updates the priority for this `Http2Stream` instance. | |
| 1477 | 1486 | ||
| 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 | - | ||
| 1481 | 1487 | #### `http2stream.rstCode` | |
| 1482 | 1488 | ||
| 1483 | 1489 | <!-- YAML | |
@@ -1572,6 +1578,11 @@ req.setTimeout(5000, () => req.close(NGHTTP2_CANCEL)); | |||
| 1572 | 1578 | ||
| 1573 | 1579 | <!-- YAML | |
| 1574 | 1580 | added: v8.4.0 | |
| 1581 | + changes: | ||
| 1582 | + - version: REPLACEME | ||
| 1583 | + pr-url: https://github.com/nodejs/node/pull/58313 | ||
| 1584 | + description: Following the deprecation of priority signaling as of RFC 1993, | ||
| 1585 | + `weight` and `sumDependencyWeight` options are deprecated. | ||
| 1575 | 1586 | --> | |
| 1576 | 1587 | ||
| 1577 | 1588 | Provides miscellaneous information about the current state of the | |
0 commit comments