1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: call out http(s).globalAgent default

Browse Source 
Despite the `http.Agent` stating:

> The default `http.globalAgent` that is used by `http.request()` has
> all of these values set to their respective defaults.

this isn't true anymore since node.js 19. Both, the http as well as the
https `globalAgent` now set `{ keepAlive: true, scheduling: 'lifo',
timeout: 5000 }` as options. `'lifo'` is the default anyway, but
`keepAlive` is turned off and no `timeout` is set on `new Agent()`.

Document the diverging behaviour in the `globalAgent` sections, remove
the false statement from `http.Agent` section, and extend the changelog
to call out the timeout change as well.

PR-URL: https://github.com/nodejs/node/pull/52392
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Paolo Insogna <paolo@cowtech.it>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
This commit is contained in:
mathis-west-1 2024-04-08 22:33:46 +02:00 committed by GitHub
parent db1746182b
commit 655b327a4d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/http.md
View File

@ -180,9 +180,6 @@ changes:
`options` in [`socket.connect()`][] are also supported.
The default [`http.globalAgent`][] that is used by [`http.request()`][] has all
of these values set to their respective defaults.
To configure any of them, a custom [`http.Agent`][] instance must be created.
```mjs
@ -3654,13 +3651,15 @@ changes:
- version:
- v19.0.0
pr-url: https://github.com/nodejs/node/pull/43522
description: The agent now uses HTTP Keep-Alive by default.
description: The agent now uses HTTP Keep-Alive and a 5 second timeout by
default.
-->
* {http.Agent}
Global instance of `Agent` which is used as the default for all HTTP client
requests.
requests. Diverges from a default `Agent` configuration by having `keepAlive`
enabled and a `timeout` of 5 seconds.
## `http.maxHeaderSize`

7
doc/api/https.md
View File

@ -327,10 +327,13 @@ changes:
- version:
- v19.0.0
pr-url: https://github.com/nodejs/node/pull/43522
description: The agent now uses HTTP Keep-Alive by default.
description: The agent now uses HTTP Keep-Alive and a 5 second timeout by
default.
-->
Global instance of [`https.Agent`][] for all HTTPS client requests.
Global instance of [`https.Agent`][] for all HTTPS client requests. Diverges
from a default [`https.Agent`][] configuration by having `keepAlive` enabled and
a `timeout` of 5 seconds.
## `https.request(options[, callback])`