Skip to content

Commit b519bce

Browse files
JonasBaaduh95
authored andcommitted
doc: remove cryptoStream API reference
PR-URL: #57579 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
1 parent 5841af2 commit b519bce

File tree

2 files changed

+6
-24
lines changed

2 files changed

+6
-24
lines changed

doc/api/deprecations.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -937,7 +937,7 @@ changes:
937937

938938
Type: End-of-Life
939939

940-
The [`tls.CryptoStream`][] class was removed. Please use
940+
The `tls.CryptoStream` class was removed. Please use
941941
[`tls.TLSSocket`][] instead.
942942

943943
### DEP0043: `tls.SecurePair`
@@ -3866,7 +3866,6 @@ When an `args` array is passed to [`child_process.execFile`][] or [`child_proces
38663866
[`timeout.ref()`]: timers.md#timeoutref
38673867
[`timeout.refresh()`]: timers.md#timeoutrefresh
38683868
[`timeout.unref()`]: timers.md#timeoutunref
3869-
[`tls.CryptoStream`]: tls.md#class-tlscryptostream
38703869
[`tls.SecureContext`]: tls.md#tlscreatesecurecontextoptions
38713870
[`tls.SecurePair`]: tls.md#class-tlssecurepair
38723871
[`tls.TLSSocket`]: tls.md#class-tlstlssocket

doc/api/tls.md

+5-22
Original file line numberDiff line numberDiff line change
@@ -547,28 +547,11 @@ description are taken from deps/openssl/openssl/crypto/x509/x509_txt.c
547547
* `'CERT_REJECTED'`: Certificate rejected.
548548
* `'HOSTNAME_MISMATCH'`: Hostname mismatch.
549549

550-
## Class: `tls.CryptoStream`
551-
552-
<!-- YAML
553-
added: v0.3.4
554-
deprecated: v0.11.3
555-
-->
556-
557-
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
558-
559-
The `tls.CryptoStream` class represents a stream of encrypted data. This class
560-
is deprecated and should no longer be used.
561-
562-
### `cryptoStream.bytesWritten`
563-
564-
<!-- YAML
565-
added: v0.3.4
566-
deprecated: v0.11.3
567-
-->
568-
569-
The `cryptoStream.bytesWritten` property returns the total number of bytes
570-
written to the underlying socket _including_ the bytes required for the
571-
implementation of the TLS protocol.
550+
When certificate errors like `UNABLE_TO_VERIFY_LEAF_SIGNATURE`,
551+
`DEPTH_ZERO_SELF_SIGNED_CERT`, or `UNABLE_TO_GET_ISSUER_CERT` occur, Node.js
552+
appends a hint suggesting that if the root CA is installed locally,
553+
try running with the `--use-system-ca` flag to direct developers towards a
554+
secure solution, to prevent unsafe workarounds.
572555

573556
## Class: `tls.SecurePair`
574557

0 commit comments

Comments
 (0)