Skip to content

Commit bb5cffc

Browse files
authored
doc: clarify DEP0207 scope
Signed-off-by: Antoine du Hamel <duhamelantoine1995@gmail.com> PR-URL: #65618 Refs: #63249 Reviewed-By: Tim Perry <pimterry@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 01c1300 commit bb5cffc

3 files changed

Lines changed: 12 additions & 6 deletions

File tree

doc/api/deprecations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4647,7 +4647,7 @@ throwing an error. This behavior is inconsistent with `hash.digest()` and
46474647
may lead to subtle bugs. Calling `hmac.digest()` on a finalized `Hmac` instance
46484648
will throw an error in a future version.
46494649
4650-
### DEP0207: `.aborted` property and `'aborted'` event in `http2`
4650+
### DEP0207: `.aborted` property and `'aborted'` event in `node:http2`
46514651
46524652
<!-- YAML
46534653
changes:

doc/api/http2.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1275,10 +1275,7 @@ destroyed.
12751275

12761276
<!-- YAML
12771277
added: v8.4.0
1278-
changes:
1279-
- version: REPLACEME
1280-
pr-url: https://github.com/nodejs/node/pull/63249
1281-
description: Documentation-only deprecation.
1278+
deprecated: REPLACEME
12821279
-->
12831280

12841281
> Stability: 0 - Deprecated. Use `'close'` and `'error'` plus
@@ -1399,10 +1396,13 @@ option must be set for this event to be emitted.
13991396

14001397
<!-- YAML
14011398
added: v8.4.0
1399+
deprecated: REPLACEME
14021400
-->
14031401

14041402
* Type: {boolean}
14051403

1404+
> Stability: 0 - Deprecated
1405+
14061406
`true` if the `Http2Stream` was closed while the writable side was
14071407
still open. When set, the `'aborted'` event was emitted.
14081408

@@ -4220,8 +4220,11 @@ data.
42204220

42214221
<!-- YAML
42224222
added: v8.4.0
4223+
deprecated: REPLACEME
42234224
-->
42244225

4226+
> Stability: 0 - Deprecated
4227+
42254228
The `'aborted'` event is emitted whenever a `Http2ServerRequest` instance
42264229
is closed while the underlying writable side is still open.
42274230

@@ -4238,10 +4241,13 @@ Just like `'end'`, this event occurs only once per response.
42384241

42394242
<!-- YAML
42404243
added: v10.1.0
4244+
deprecated: REPLACEME
42414245
-->
42424246

42434247
* Type: {boolean}
42444248

4249+
> Stability: 0 - Deprecated
4250+
42454251
The `request.aborted` property will be `true` if the request has
42464252
been aborted.
42474253

test/doctool/test-doc-api-json.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,5 +158,5 @@ for await (const dirent of await fs.opendir(new URL('../../out/doc/api/', import
158158
assert.partialDeepStrictEqual(allExpectedKeys, findAllKeys(json));
159159
}
160160

161-
assert.strictEqual(numberOfDeprecatedSections, 45); // Increase this number every time a new API is deprecated.
161+
assert.strictEqual(numberOfDeprecatedSections, 49); // Increase this number every time a new API is deprecated.
162162
assert.strictEqual(numberOfRemovedAPIs, 46); // Increase this number every time a section is marked as removed.

0 commit comments

Comments
 (0)