Skip to content

Commit

Permalink
doc: add note for hwm restriction in tls
Browse files Browse the repository at this point in the history
Also restores change entries for `highWaterMark` option
in `tls` and `https` docs.
  • Loading branch information
puzpuzpuz committed May 13, 2020
1 parent 6324732 commit de46fc4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
8 changes: 8 additions & 0 deletions doc/api/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,14 @@ Global instance of [`https.Agent`][] for all HTTPS client requests.
<!-- YAML
added: v0.3.6
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/33387
description: The `highWaterMark` option is not supported now.
- version:
- v14.1.0
- v13.14.0
pr-url: https://github.com/nodejs/node/pull/32786
description: The `highWaterMark` option is accepted now.
- version: v10.9.0
pr-url: https://github.com/nodejs/node/pull/21616
description: The `url` parameter can now be passed along with a separate
Expand Down
12 changes: 11 additions & 1 deletion doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1280,6 +1280,14 @@ being issued by trusted CA (`options.ca`).
<!-- YAML
added: v0.11.3
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/33387
description: The `highWaterMark` option is not supported now.
- version:
- v14.1.0
- v13.14.0
pr-url: https://github.com/nodejs/node/pull/32786
description: The `highWaterMark` option is accepted now.
- version:
- v13.6.0
- v12.16.0
Expand Down Expand Up @@ -1386,7 +1394,9 @@ changes:
`tls.createSecureContext()`.
* ...: [`tls.createSecureContext()`][] options that are used if the
`secureContext` option is missing, otherwise they are ignored.
* ...: Any [`socket.connect()`][] option not already listed.
* ...: Any [`socket.connect()`][] option not already listed with the following
exception. The `highWaterMark` option is not supported, as the TLS protocol
assumes 16KB as the maximum record size.
* `callback` {Function}
* Returns: {tls.TLSSocket}

Expand Down

0 comments on commit de46fc4

Please sign in to comment.