Skip to content

Commit 7d0df64

Browse files
committed
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 1e6d7da commit 7d0df64

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

doc/api/deprecations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3795,7 +3795,7 @@ The `node:_stream_duplex`, `node:_stream_passthrough`, `node:_stream_readable`,
37953795
`node:_stream_wrap` and `node:_stream_writable` modules are deprecated as they should be considered
37963796
an internal nodejs implementation rather than a public facing API, use `node:stream` instead.
37973797

3798-
### DEP0194: `require('node:http2').Http2Stream.priority`
3798+
### DEP0194: HTTP/2 priority signaling
37993799

38003800
<!-- YAML
38013801
changes:

doc/api/http2.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1071,6 +1071,11 @@ The `'origin'` event is only emitted when using a secure TLS connection.
10711071

10721072
<!-- YAML
10731073
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.
10741079
-->
10751080

10761081
* `headers` {HTTP/2 Headers Object}
@@ -1087,7 +1092,8 @@ added: v8.4.0
10871092
created stream is dependent on.
10881093
* `weight` {number} Specifies the relative dependency of a stream in relation
10891094
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.
10911097
* `waitForTrailers` {boolean} When `true`, the `Http2Stream` will emit the
10921098
`'wantTrailers'` event after the final `DATA` frame has been sent.
10931099
* `signal` {AbortSignal} An AbortSignal that may be used to abort an ongoing
@@ -1460,6 +1466,9 @@ added: v8.4.0
14601466
deprecated: REPLACEME
14611467
-->
14621468

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+
14631472
* `options` {Object}
14641473
* `exclusive` {boolean} When `true` and `parent` identifies a parent Stream,
14651474
this stream is made the sole direct dependency of the parent, with
@@ -1475,9 +1484,6 @@ deprecated: REPLACEME
14751484

14761485
Updates the priority for this `Http2Stream` instance.
14771486

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-
14811487
#### `http2stream.rstCode`
14821488

14831489
<!-- YAML
@@ -1572,6 +1578,11 @@ req.setTimeout(5000, () => req.close(NGHTTP2_CANCEL));
15721578

15731579
<!-- YAML
15741580
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.
15751586
-->
15761587

15771588
Provides miscellaneous information about the current state of the

0 commit comments

Comments
 (0)