-
Notifications
You must be signed in to change notification settings - Fork 29.1k
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
doc: consider documenting allowHalfOpen property #38989
Comments
This should be documented. |
Excellent, ok! I'll put a PR together to document this. |
Closed as #39126 has been landed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
📗 API Reference Docs Problem
Location
Section of the site where the content exists
Affected URL(s):
Description
All duplex streams have an
allowHalfOpen
property, which is publicly visible and writeable, with no documentation AFAICT but also no indication that it's intended as an internal-only API.The constructor option is documented, but not the property on the stream instance itself.
I have two questions:
As far as I can tell the answer to both is yes, but I'm hoping somebody can confirm that, and if so I think it would be useful to document these explicitly.
If one or neither is safe of course that's useful information! In that case maybe this should be underscored or similar to make it clear that it's an internal API.
submit a pull request.
The text was updated successfully, but these errors were encountered: