Skip to content
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

Jump to bottom

net.createServer options are not correctly described. #44298

Closed
mousseq opened this issue Aug 19, 2022 · 0 comments · Fixed by #44326
Closed

net.createServer options are not correctly described. #44298

mousseq opened this issue Aug 19, 2022 · 0 comments · Fixed by #44326
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Comments

@mousseq
Copy link

mousseq commented Aug 19, 2022

The net.createServer documentation indicates that the method takes an options object. The description of the options indicates that there are five possible attributes. The @types/node net declaration of the ServerOpts interface contains only the first two attributes (allowHalfOpen, and pauseOnConnect). Unsurprisingly, attempting to set one of the other options incurs a typescript error. This appears in the 18.7 version of the documentation and earlier.
@VoltrexKeyva VoltrexKeyva added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Aug 20, 2022
lpinca added a commit to lpinca/node that referenced this issue Aug 21, 2022
@lpinca
doc: add history for net.createServer() options
fce452b 
Fixes: nodejs#44298
@lpinca lpinca mentioned this issue Aug 21, 2022
Merged
@ZYSzys ZYSzys mentioned this issue Aug 21, 2022
Merged
8 tasks
lpinca added a commit to lpinca/node that referenced this issue Aug 21, 2022
@lpinca
doc: add history for net.createServer() options
e0ad8b1 
Fixes: nodejs#44298
nodejs-github-bot pushed a commit that referenced this issue Aug 23, 2022
@lpinca
doc: add history for net.createServer() options
e0191ca 
Fixes: #44298
PR-URL: #44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
RafaelGSS pushed a commit that referenced this issue Sep 5, 2022
@lpinca @RafaelGSS
doc: add history for net.createServer() options
65c1f40 
Fixes: #44298
PR-URL: #44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Fyko pushed a commit to Fyko/node that referenced this issue Sep 15, 2022
@lpinca @Fyko
doc: add history for net.createServer() options
2fce5c8 
Fixes: nodejs#44298
PR-URL: nodejs#44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
targos pushed a commit that referenced this issue Sep 16, 2022
@lpinca @targos
doc: add history for net.createServer() options
18dbe37 
Fixes: #44298
PR-URL: #44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
juanarbol pushed a commit that referenced this issue Oct 10, 2022
@lpinca @juanarbol
doc: add history for net.createServer() options
1d2bea4 
Fixes: #44298
PR-URL: #44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
juanarbol pushed a commit that referenced this issue Oct 11, 2022
@lpinca @juanarbol
doc: add history for net.createServer() options
a1dbe4b 
Fixes: #44298
PR-URL: #44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this issue Jan 3, 2023
@lpinca @guangwong
doc: add history for net.createServer() options
bfa0d1a 
Fixes: nodejs/node#44298
PR-URL: nodejs/node#44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this issue Jan 3, 2023
@lpinca @guangwong
doc: add history for net.createServer() options
65f044c 
Fixes: nodejs/node#44298
PR-URL: nodejs/node#44326
Reviewed-By: Paolo Insogna <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Yongsheng Zhang <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
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 a pull request may close this issue.

doc: add history for net.createServer() options lpinca/node
2 participants
@VoltrexKeyva @mousseq