FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: clarify socket destroyed behavior by dayun6530 · Pull Request #65395 · nodejs/node · GitHub

/ node Public

doc: clarify socket destroyed behavior - #65395

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
dayun6530:doc/clarify-net-socket-destroy
Aug 21, 2026
ConversationCommits (1)ChecksFiles changed
Merged

doc: clarify socket destroyed behavior#65395
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
dayun6530:doc/clarify-net-socket-destroy

Conversation

dayun6530 commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Clarify the socket.destroyed documentation to reflect that a destroyed
net.Socket can be reused by calling socket.connect() again.

The previous wording could be read as if no further data transfer were ever
possible after destruction, while the socket can be reconnected and used again.

Fixes: #57367

Tests: make lint-md

nodejs-github-bot commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/net

nodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Aug 19, 2026
daeyeon reviewed Aug 20, 2026
View reviewed changes
Comment thread doc/api/net.md Outdated
daeyeon reviewed Aug 20, 2026
View reviewed changes

daeyeon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

node/doc/api/net.md

Lines 1446 to 1456 in 449b950

### `socket.destroy([error])`
<!-- YAML
added: v0.1.90
-->
* `error` {Object}
* Returns: {net.Socket}
Ensures that no more I/O activity happens on this socket.
Destroys the stream and closes the connection.

Could we also clarify socket.destroy() similarly? Its current wording could imply that the Socket object is permanently unusable.

doc: clarify socket destroyed behavior
00b9e59 
Signed-off-by: Dayun <dlekdbs6530@gmail.com>
dayun6530 force-pushed the doc/clarify-net-socket-destroy branch from 27070c9 to 00b9e59 Compare August 20, 2026 04:29

dayun6530 commented Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

Thanks! I updated the wording as suggested and also clarified socket.destroy().

daeyeon added author ready PRs that have at least one approval, no outstanding review comments, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 20, 2026
nodejs-github-bot merged commit c5d4ae6 into nodejs:main Aug 21, 2026
22 checks passed

nodejs-github-bot commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Landed in c5d4ae6

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 21, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
doc: clarify socket destroyed behavior
e1fa4b4 
Signed-off-by: Dayun <dlekdbs6530@gmail.com>
PR-URL: #65395
Fixes: #57367
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
doc: clarify socket destroyed behavior
96b91dc 
Signed-off-by: Dayun <dlekdbs6530@gmail.com>
PR-URL: #65395
Fixes: #57367
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
github-actions Bot mentioned this pull request Aug 25, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
daeyeon daeyeon approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

sockets can be undestroyed, confusing documentation

4 participants

Back | FazBrowse Home | New Git URL