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.

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

socket.destroyed is left undocumented? #5898

Closed
tusharmath opened this issue Mar 25, 2016 · 4 comments
Closed

socket.destroyed is left undocumented? #5898

tusharmath opened this issue Mar 25, 2016 · 4 comments
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Comments

@tusharmath
Copy link
Contributor

Hi, this is my first report to node.js and I apologies in advance if the issue doesn't make sense.

I was going thru the documentation of the net module and found out that the destroyed property isn't documented. I was wondering if that is an official API or not to check the status of the socket connection. If not destroyed what else can I use to check the current status of the socket connection?

Node Version : Node.js v5.9.1 Documentation

Thanks.

@mscdex mscdex added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Mar 25, 2016
@cjihrig
Copy link
Contributor

cjihrig commented Mar 25, 2016

It's not prefixed with an underscore, so it would make sense to me to have it documented.

@benjamingr
Copy link
Member

I agree we should document it.

@tusharmath would you be interested in writing the said file and contributing through a pull reuqest? I can walk you through the process if you'd like.

If you prefer not to that's also entirely fine too :)

@benjamingr benjamingr added the good first issue Issues that are suitable for first-time contributors. label Mar 27, 2016
@tusharmath
Copy link
Contributor Author

@benjamingr absolutely!

tusharmath added a commit to tusharmath/node that referenced this issue Apr 9, 2016
@dotnetCarpenter
Copy link

Nice! I just filed a similar issue in the wrong repo #667

ReadStream.prototype.destroy is missing from the documentation. Others, than me, have had questions about it. I think it's about time to get the method documented 👯

@Fishrock123 Fishrock123 removed the good first issue Issues that are suitable for first-time contributors. label May 5, 2016
evanlucas pushed a commit that referenced this issue Jun 27, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Fishrock123 pushed a commit that referenced this issue Jun 27, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this issue Jul 11, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this issue Jul 11, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this issue Jul 12, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this issue Jul 14, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this issue Jul 14, 2016
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants