http.ClientRequest poor documentation

[magicdawn]

I'm using tj's superagent, and I want to inspect the actual url requesting

var request = require('superagent');

request
   .get('<some url>')
   .on('request',function(){
        var req = this.req; // req instanceof http.ClientRequest
    })
   .end(function(err,res){

    })

req instanceof http.ClientRequest, but I can hardly find any property reference in the documentation on http.ClientRequest class https://iojs.org/api/http.html#http_class_http_clientrequest

[Fishrock123]

It might not be sorted the best but I do believe everything is there under http.ClientRequest and http.IncomingMessage. Please let us know if there is something specific missing!

[Fishrock123]

You may also want to do a nodeschool workshopper, npm install -g learnyounode -- they are pretty helpful!

[magicdawn]

Yeah, I know ClientRequest.prototype.end/write and normally we use http.request or http.get, we won't want to access the property on ClientRequest, but under some circumstance such as above example above want to access req as ClientRequest 's property, such as url , path, domain , host...blabla

but only

• req.method https://github.com/nodejs/node/blob/master/lib%2F_http_client.js#L69
• req.path https://github.com/nodejs/node/blob/master/lib%2F_http_client.js#L70

available, and they are not in the documentation

[magicdawn]

every property which is not start with a leading lodash _ is public. Am I wrong

[sam-github]

@magicdawn I'm having difficulty understanding what you are trying to say. Is there some specific property that you think is public and that is not documented? If so, which ones?

[magicdawn]

@sam-github yeah, that's I'm saying.

path method can be accessed, but not in the documentation
and host/protocal should be exposed too.

[Fishrock123]

Not everything that is "publicly exposed" (i.e. exposed without a _) is documented. Some of this is probably intentional. Other, it is possible no-one got around to writing the docs for.

We'd probably happy to take a PR to add docs for those I think. :)