References to an "KeepAlive" flag in the http.Agent constructor, when it is actually "keepAlive"

Version:
Platform:
Subsystem:

In the version 7.3.0 documentation, in the page on http, in the first few paragraphs of the http.Agent section it makes references to a KeepAlive flag in the http.Agent constructor which you can specify as true if you'd like to keep unused sockets pooled. Admittedly this caused me a decent amount of confusion because of the case mismatch :)

@papiro

@papiro would you be interested in making a contribution to the documentation that fixes this? It would be greatly appreciated. The actual file that is used to generate that documentation can be found at https://github.com/nodejs/node/blob/master/doc/api/http.md. Feel free to ping me if you have any questions on making this change. Thanks for bringing it to our attention!

@papiro

Adding the good first contribution label, if anyone would like to PR this change (including @papiro !) then awesome.

I'll give it a shot :) Thanks!

To be honest, I'm trying to grok what the documentation is actually trying to say and I just don't get it. This line specifically:

This means that Node.js's pool has the benefit of keep-alive when under load but still does not require developers to manually close the HTTP clients using KeepAlive.

Is it referring to HTTP clients with an agent that has the keepAlive flag set to true (Nodejs-specific)? I've googled "KeepAlive" and can't find any useful references to it (everything seems to be talking about the Connection header with a value of keep-alive.

Also, this line:

If you opt into using HTTP KeepAlive...

Is it referring again to the option to the http.Agent constructor? It's confusing because it refers to it as "HTTP" KeepAlive, which makes me think it's not Node-specific.

Any clarity on these would be greatly appreciated.

Changes to http.md

Is this stilla point?

The meaning of what is being said is still unclear to me, yes. Get Outlook for Android<https://aka.ms/ghei36> On Mon, Jan 9, 2017 at 3:13 PM -0500, "Martina Kraus" <notifications@github.com<mailto:notifications@github.com>> wrote: Is this stilla point? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#10567 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AHxBhMCwBAn4gwFQaQkHM2RWGmpF2u4hks5rQpTwgaJpZM4LYxSC>.

Have you seen #10715, in process of addressing this?

Awesome! Looking forward to reading it ☺ Get Outlook for Android<https://aka.ms/ghei36> On Mon, Jan 9, 2017 at 4:08 PM -0500, "Sam Roberts" <notifications@github.com<mailto:notifications@github.com>> wrote: Have you seen #10715<#10715>, in process of addressing this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#10567 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AHxBhK04QCqGiWd3w3OvrowfCv1wORi6ks5rQqHCgaJpZM4LYxSC>.

doc: update http.md for consistency and clarity

Navigation Menu

Repository navigation

References to an "KeepAlive" flag in the http.Agent constructor, when it is actually "keepAlive" #10567

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

References to an "KeepAlive" flag in the http.Agent constructor, when it is actually "keepAlive" #10567

Description

Activity

evanlucas commented on Jan 2, 2017

gibfahn commented on Jan 2, 2017

papiro commented on Jan 2, 2017

papiro commented on Jan 2, 2017

martinakraus commented on Jan 9, 2017

papiro commented on Jan 9, 2017

sam-github commented on Jan 9, 2017

papiro commented on Jan 9, 2017

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions