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

http.ClientRequest's 'error' event is undocumented #16982

Closed
strugee opened this issue Nov 13, 2017 · 3 comments
Closed

http.ClientRequest's 'error' event is undocumented #16982

strugee opened this issue Nov 13, 2017 · 3 comments
Labels
doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. http Issues or PRs related to the http subsystem. question Issues that look for answers.

Comments

@strugee
Copy link
Contributor

strugee commented Nov 13, 2017

  • Version: 9.1.0
  • Platform: all
  • Subsystem: doc

Maybe I'm just missing something, but AFAIK all instances of http.ClientRequest can emit error events. However, I can't find any mention of this on https://nodejs.org/api/http.html#http_class_http_clientrequest.

@mscdex
Copy link
Contributor

mscdex commented Nov 13, 2017

The 'error' event is special for all EventEmitters. That event is described in the events documentation.

@mscdex mscdex added events Issues and PRs related to the events subsystem / EventEmitter. http Issues or PRs related to the http subsystem. question Issues that look for answers. labels Nov 13, 2017
@joyeecheung
Copy link
Member

joyeecheung commented Nov 15, 2017

It would make things clearer if we have a better convention on documenting the inheritance/interface implementation, right now it's a bit scattered like:

The request implements the Writable Stream interface. This is an EventEmitter with the following events:

hidden between paragraphs

@joyeecheung joyeecheung added the doc Issues and PRs related to the documentations. label Nov 15, 2017
@apapirovski
Copy link
Member

It doesn't seem like there's anything actionable here. If docs need improving perhaps an issue could be opened that mentions what should change so that first time contributors can help out. As is, this hasn't been looked at in 6 months.

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. events Issues and PRs related to the events subsystem / EventEmitter. http Issues or PRs related to the http subsystem. question Issues that look for answers.
Projects
None yet
Development

No branches or pull requests

4 participants