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: https://github.com/nodejs/node/pull/58504 Backport-PR-URL: https://github.com/nodejs/node/pull/58542 Refs: https://github.com/nodejs/node/pull/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>
This commit is contained in:
parent
1e6d7da0ce
commit
7d0df646f6
@ -3795,7 +3795,7 @@ The `node:_stream_duplex`, `node:_stream_passthrough`, `node:_stream_readable`,
|
|||||||
`node:_stream_wrap` and `node:_stream_writable` modules are deprecated as they should be considered
|
`node:_stream_wrap` and `node:_stream_writable` modules are deprecated as they should be considered
|
||||||
an internal nodejs implementation rather than a public facing API, use `node:stream` instead.
|
an internal nodejs implementation rather than a public facing API, use `node:stream` instead.
|
||||||
|
|
||||||
### DEP0194: `require('node:http2').Http2Stream.priority`
|
### DEP0194: HTTP/2 priority signaling
|
||||||
|
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
changes:
|
changes:
|
||||||
|
@ -1071,6 +1071,11 @@ The `'origin'` event is only emitted when using a secure TLS connection.
|
|||||||
|
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: v8.4.0
|
added: v8.4.0
|
||||||
|
changes:
|
||||||
|
- version: REPLACEME
|
||||||
|
pr-url: https://github.com/nodejs/node/pull/58313
|
||||||
|
description: Following the deprecation of priority signaling as of RFC 1993,
|
||||||
|
`weight` option is deprecated.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
* `headers` {HTTP/2 Headers Object}
|
* `headers` {HTTP/2 Headers Object}
|
||||||
@ -1087,7 +1092,8 @@ added: v8.4.0
|
|||||||
created stream is dependent on.
|
created stream is dependent on.
|
||||||
* `weight` {number} Specifies the relative dependency of a stream in relation
|
* `weight` {number} Specifies the relative dependency of a stream in relation
|
||||||
to other streams with the same `parent`. The value is a number between `1`
|
to other streams with the same `parent`. The value is a number between `1`
|
||||||
and `256` (inclusive).
|
and `256` (inclusive). This has been **deprecated** in [RFC 9113][], and
|
||||||
|
support for it will be removed in future versions of Node.js.
|
||||||
* `waitForTrailers` {boolean} When `true`, the `Http2Stream` will emit the
|
* `waitForTrailers` {boolean} When `true`, the `Http2Stream` will emit the
|
||||||
`'wantTrailers'` event after the final `DATA` frame has been sent.
|
`'wantTrailers'` event after the final `DATA` frame has been sent.
|
||||||
* `signal` {AbortSignal} An AbortSignal that may be used to abort an ongoing
|
* `signal` {AbortSignal} An AbortSignal that may be used to abort an ongoing
|
||||||
@ -1460,6 +1466,9 @@ added: v8.4.0
|
|||||||
deprecated: REPLACEME
|
deprecated: REPLACEME
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
> Stability: 0 - Deprecated: support for priority signaling has been deprecated
|
||||||
|
> in the [RFC 9113][] and is no longer supported in Node.js.
|
||||||
|
|
||||||
* `options` {Object}
|
* `options` {Object}
|
||||||
* `exclusive` {boolean} When `true` and `parent` identifies a parent Stream,
|
* `exclusive` {boolean} When `true` and `parent` identifies a parent Stream,
|
||||||
this stream is made the sole direct dependency of the parent, with
|
this stream is made the sole direct dependency of the parent, with
|
||||||
@ -1475,9 +1484,6 @@ deprecated: REPLACEME
|
|||||||
|
|
||||||
Updates the priority for this `Http2Stream` instance.
|
Updates the priority for this `Http2Stream` instance.
|
||||||
|
|
||||||
The support for priority signaling has been deprecated in the [RFC 9113][], and
|
|
||||||
will be removed in future versions of Node.js.
|
|
||||||
|
|
||||||
#### `http2stream.rstCode`
|
#### `http2stream.rstCode`
|
||||||
|
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
@ -1572,6 +1578,11 @@ req.setTimeout(5000, () => req.close(NGHTTP2_CANCEL));
|
|||||||
|
|
||||||
<!-- YAML
|
<!-- YAML
|
||||||
added: v8.4.0
|
added: v8.4.0
|
||||||
|
changes:
|
||||||
|
- version: REPLACEME
|
||||||
|
pr-url: https://github.com/nodejs/node/pull/58313
|
||||||
|
description: Following the deprecation of priority signaling as of RFC 1993,
|
||||||
|
`weight` and `sumDependencyWeight` options are deprecated.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
Provides miscellaneous information about the current state of the
|
Provides miscellaneous information about the current state of the
|
||||||
|
Loading…
x
Reference in New Issue
Block a user