Skip to content

doc: clarify DEP0207 scope #65618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aduh95 wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −6
Open

doc: clarify DEP0207 scope #65618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4647,7 +4647,7 @@ throwing an error. This behavior is inconsistent with `hash.digest()` and
may lead to subtle bugs. Calling `hmac.digest()` on a finalized `Hmac` instance
will throw an error in a future version.

### DEP0207: `.aborted` property and `'aborted'` event in `http2`
### DEP0207: `.aborted` property and `'aborted'` event in `node:http2`

<!-- YAML
changes:
Expand Down
14 changes: 10 additions & 4 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1275,10 +1275,7 @@ destroyed.

<!-- YAML
added: v8.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/63249
description: Documentation-only deprecation.
deprecated: REPLACEME
-->

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

<!-- YAML
added: v8.4.0
deprecated: REPLACEME
-->

* Type: {boolean}

> Stability: 0 - Deprecated

`true` if the `Http2Stream` was closed while the writable side was
still open. When set, the `'aborted'` event was emitted.

Expand Down Expand Up @@ -4220,8 +4220,11 @@ data.

<!-- YAML
added: v8.4.0
deprecated: REPLACEME
-->

> Stability: 0 - Deprecated

The `'aborted'` event is emitted whenever a `Http2ServerRequest` instance
is closed while the underlying writable side is still open.

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

<!-- YAML
added: v10.1.0
deprecated: REPLACEME
-->

* Type: {boolean}

> Stability: 0 - Deprecated

The `request.aborted` property will be `true` if the request has
been aborted.

Expand Down
2 changes: 1 addition & 1 deletion test/doctool/test-doc-api-json.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,5 +158,5 @@ for await (const dirent of await fs.opendir(new URL('../../out/doc/api/', import
assert.partialDeepStrictEqual(allExpectedKeys, findAllKeys(json));
}

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