Node: http.ClientRequest's 'error' event is undocumented

Created on 13 Nov 2017  路  3Comments  路  Source: nodejs/node

  • 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.

doc events http question

Most helpful comment

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

All 3 comments

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

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

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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

addaleax picture addaleax  路  3Comments

ksushilmaurya picture ksushilmaurya  路  3Comments

mcollina picture mcollina  路  3Comments

srl295 picture srl295  路  3Comments

dfahlander picture dfahlander  路  3Comments