Skip to content

Commit d50fc51

Browse files
nicolas-moteauBridgeAR
authored andcommitted
doc: add missing https Agent maxCachedSessions
PR-URL: nodejs#26433 Refs: nodejs#2228 Refs: nodejs#4252 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 31147c4 commit d50fc51

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/api/https.md

+19
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,28 @@ separate module.
1010
## Class: https.Agent
1111
<!-- YAML
1212
added: v0.4.5
13+
changes:
14+
- version: v2.5.0
15+
pr-url: https://github.com/nodejs/node/pull/2228
16+
description: parameter `maxCachedSessions` added to `options` for TLS
17+
sessions reuse.
18+
- version: v5.3.0
19+
pr-url: https://github.com/nodejs/node/pull/4252
20+
description: support `0` `maxCachedSessions` to disable TLS session caching.
1321
-->
1422

1523
An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See
1624
[`https.request()`][] for more information.
1725

26+
### new Agent([options])
27+
28+
* `options` {Object} Set of configurable options to set on the agent.
29+
Can have the same fields as for [`http.Agent(options)`][], and
30+
* `maxCachedSessions` {number} maximum number of TLS cached sessions.
31+
Use `0` to disable TLS session caching. **Default:** `100`.
32+
33+
See [`Session Resumption`][] for infomation about TLS session reuse.
34+
1835
## Class: https.Server
1936
<!-- YAML
2037
added: v0.3.4
@@ -369,6 +386,7 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
369386
[`Agent`]: #https_class_https_agent
370387
[`URL`]: url.html#url_the_whatwg_url_api
371388
[`http.Agent`]: http.html#http_class_http_agent
389+
[`http.Agent(options)`]: http.html#http_new_agent_options
372390
[`http.Server#headersTimeout`]: http.html#http_server_headerstimeout
373391
[`http.Server#keepAliveTimeout`]: http.html#http_server_keepalivetimeout
374392
[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount
@@ -387,3 +405,4 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p
387405
[`tls.connect()`]: tls.html#tls_tls_connect_options_callback
388406
[`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_options
389407
[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener
408+
[`Session Resumption`]: tls.html#tls_session_resumption

0 commit comments

Comments
 (0)