Skip to content

doc: update Http2Server.close & Http2SecureServer.close #63298

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
samuel871211 wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −9
Open

doc: update Http2Server.close & Http2SecureServer.close #63298

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
11 changes: 2 additions & 9 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2437,10 +2437,7 @@ added: v8.4.0

* `callback` {Function}

Stops the server from establishing new sessions. This does not prevent new
request streams from being created due to the persistent nature of HTTP/2
sessions. To gracefully shut down the server, call [`http2session.close()`][] on
all active sessions.
Stops the server from establishing new sessions and streams.

If `callback` is provided, it is not invoked until all active sessions have been
closed, although the server has already stopped allowing new sessions. See
Expand Down Expand Up @@ -2721,10 +2718,7 @@ added: v8.4.0

* `callback` {Function}

Stops the server from establishing new sessions. This does not prevent new
request streams from being created due to the persistent nature of HTTP/2
sessions. To gracefully shut down the server, call [`http2session.close()`][] on
all active sessions.
Stops the server from establishing new sessions and streams.

If `callback` is provided, it is not invoked until all active sessions have been
closed, although the server has already stopped allowing new sessions. See
Expand Down Expand Up @@ -5058,7 +5052,6 @@ you need to implement any fall-back behavior yourself.
[`http2.Server`]: #class-http2server
[`http2.createSecureServer()`]: #http2createsecureserveroptions-onrequesthandler
[`http2.createServer()`]: #http2createserveroptions-onrequesthandler
[`http2session.close()`]: #http2sessionclosecallback
Copy link
Copy Markdown
Contributor Author

@samuel871211 samuel871211 May 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WHY？

Because：

https://github.com/nodejs/node/actions/runs/25840207727/job/76301962849

doc/api/http2.md
5031:1-5031:53 warning Unexpected unused definition, expected no definition or one or more references to http2session.close() no-unused-definitions remark-lint

⚠ 1 warning
make: *** [Makefile:1464: tools/.mdlintstamp] Error 1
Error: Process completed with exit code 2.

[`http2stream.pushStream()`]: #http2streampushstreamheaders-options-callback
[`import()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import
[`net.Server.close()`]: net.md#serverclosecallback
Expand Down
Loading